FB_EntitiesHandler - GetConveyor (Method)

Overview

Type:

Method

Available as of:

V1.4.1.0

This chapter provides information on:

Task

Retrieve the information on a conveyor entity.

Description

The method GetConveyor is used to retrieve the information on a conveyor entity previously stored inside the internal list of the function block.

Interface

Input

Data type

Description

i_etSystemId

ET_SystemEntity

An ID used to unequivocally identify the sensor-conveyor pair in the system.

Admissible values are in the range ET_SystemEntity.Conveyor1...ET_SystemEntity.Conveyor30.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING[80]

Event-triggered message that gives more detailed information on the diagnostic state.

Return Value

Data type

Description

ST_ConveyorEntityData

It returns a data structure containing information on a selected conveyor entity, previously stored inside the function block.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

InputParameterInvalid

ConveyorIdInvalid

145

A provided conveyor ID is invalid.

InputParameterInvalid

ConveyorIdUnknown

133

A provided conveyor ID is invalid.

ConveyorIdInvalid

Enumeration name:

ConveyorIdInvalid

Enumeration value:

145

Description:

A provided conveyor ID is invalid.

Issue

Cause

Solution

A conveyor entity has not been retrieved successfully from the list.

i_etSystemId contains an invalid entity ID.

Ensure that the value of i_etSystemId refers to an entity ID in the range ET_SystemEntity.Conveyor1...ET_SystemEntity.Conveyor30.

ConveyorIdUnknown

Enumeration name:

ConveyorIdUnknown

Enumeration value:

133

Description:

A provided conveyor ID is invalid.

Issue

Cause

Solution

A conveyor entity has not been successfully retrieved from the list.

i_tSystemId contains an invalid robot system ID.

Ensure that the value of i_etSystemId refers to a previously configured conveyor.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

Status message: A conveyor entity has been successfully retrieved from the list.