FB_EntitiesHandler - GetTrackingSystem (Method)

Overview

Type:

Method

Available as of:

V1.6.0.0

This chapter provides information on:

Task

Get information on the tracking system.

Description

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

Interface

Access: PUBLIC

Input

Data type

Description

i_etTrackingSystemId

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 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 additional information on the diagnostic state.

Return Value

Data type

Description

ST_TrackingSystemData

Stores information for a tracking system.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

OK

0

Ok

InputParameterInvalid

TrackingIdInvalid

104

The tracking ID is invalid.

InputParameterInvalid

TrackingIdUnknown

131

A provided tracking ID is invalid.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

TrackingIdInvalid

Enumeration name:

TrackingIdInvalid

Enumeration value:

104

Description:

The tracking ID is invalid.

Issue

Cause

Solution

A tracking system has not been retrieved successfully from the list.

i_etSystemId contains an invalid value.

Ensure that the ID is 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 tracking system has not been retrieved successfully from the list.

i_etSystemId contains an invalid value.

Ensure that the tracking system ID refers to a previously configured system.