FB_EntitiesHandler - GetLinearTrackingSystem (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

Task
Description
Interface
Diagnostic Messages

Task

Retrieve the information on a linear tracking system.

Description

The method GetLinearTrackingSystem is used to retrieve the information on a linear tracking system previously stored inside the internal list of the function block.

Interface

Input	Data type	Description
i_etSystemId	ROB.ET_CoordinateSystem	An ID used to unequivocally identify a tracking system. Admissible values are in the range ROB.ET_CoordinateSystem.Tracking1...ROB.ET_CoordinateSystem.Tracking30.

Input

Data type

Description

i_etSystemId

ROB.ET_CoordinateSystem

An ID used to unequivocally identify a tracking system.

Admissible values are in the range ROB.ET_CoordinateSystem.Tracking1...ROB.ET_CoordinateSystem.Tracking30.

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.
q_stLinearTrackingSystemData	ST_LinearTrackingSystemData	A data structure containing information on a selected tracking system that was previously stored inside the function block.
q_stConveyorData	ST_ConveyorEntityData	A data structure containing information on the conveyor entity linked to the selected tracking system that was previously stored inside the function block.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	Ok
UnexpectedProgramBehavior	ConveyorIdInvalid	145	A provided conveyor ID is invalid.
UnexpectedProgramBehavior	ConveyorIdUnknown	133	A provided conveyor ID is invalid.
InputParameterInvalid	TrackingIdInvalid	104	The tracking ID is invalid.
InputParameterInvalid	TrackingIdUnknown	131	A provided tracking ID is invalid.

ConveyorIdInvalid

Enumeration name:	ConveyorIdInvalid
Enumeration value:	145
Description:	A provided conveyor ID is invalid.

Issue	Cause	Solution
A linear tracking system has not been retrieved successfully from the list.	It was impossible to retrieve information on the conveyor system linked to the selected tracking system.	The conveyor ID linked to the selected tracking system contains an invalid value.

ConveyorIdUnknown

Enumeration name:	ConveyorIdUnknown
Enumeration value:	133
Description:	A provided conveyor ID is invalid.

Issue	Cause	Solution
A linear tracking system has not been successfully retrieved from the list.	It was impossible to retrieve information on the conveyor system linked to the selected tracking system.	The conveyor id linked to the selected tracking system does not appear to be configured.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Success

Status message: A linear tracking system has been retrieved successfully from the list.

TrackingIdInvalid

Enumeration name:	TrackingIdInvalid
Enumeration value:	104
Description:	The tracking ID is invalid.

Issue	Cause	Solution
A linear tracking system has not been retrieved successfully from the list.	i_etSystemId contains an invalid tracking ID.	Ensure that i_etSystemId contains a value in the range ROB.ET_CoordinateSystem.Tracking1...ROB.ET_CoordinateSystem.Tracking30.

TrackingIdUnknown

Enumeration name:	TrackingIdUnknown
Enumeration value:	131
Description:	A provided tracking ID is invalid.

Issue	Cause	Solution
A linear tracking system has not been retrieved successfully from the list.	i_etSystemId refers to an indeterminable tracking system.	Ensure that a tracking system with ID i_etSystemId has been already configured before calling this method.