IF_ConfigurationAdvanced - GetTrackingParameters (Method)

Overview

Type:

Method

Available as of:

V2.10.0.0

This chapter provides information on:

Task

Retrieve a set of parameters from a specific tracking system.

Description

With the method GetTrackingParameters(…), a set of parameters can be retrieved from a tracking system.

Interface

Input

Data type

Description

i_etTrackingSystem

ROB.ET_CoordinateSystem

Tracking system from which the parameters should be retrieved.

Valid value: Identifier of a configured tracking system.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic.

A value not equal 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 additional information on the diagnostic state.

q_stParameters

ROB.ST_TrackingParameters

Parameters that should be retrieved from the tracking system transferred at input i_etTrackingSystem.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

InputParameterInvalid

CoordinateSystemInvalid

93

The coordinate system is invalid.

InputParameterInvalid

CoordinateSystemNotConfigured

268

The coordinate system is not configured.

UnexpectedProgramBehavior

UnexpectedFeedback

28

A feedback value was invalid.

CoordinateSystemInvalid

Enumeration name:

CoordinateSystemInvalid

Enumeration value:

93

Description:

The coordinate system is invalid.

Issue

Cause

Solution

Retrieving the tracking parameters was unsuccessful.

The value transferred at the input i_etTrackingSystem does not represent a tracking system.

Verify that at the input i_etTrackingSystem a configured tracking system is transferred, and correct if necessary.

CoordinateSystemNotConfigured

Enumeration name:

CoordinateSystemNotConfigured

Enumeration value:

268

Description:

The coordinate system is not configured.

Issue

Cause

Solution

Retrieving the tracking parameters was unsuccessful.

The value transferred at the input i_etTrackingSystem does not represent a configured tracking system.

Verify that at the input i_etTrackingSystem a configured tracking system is transferred, and correct if necessary.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Retrieving the tracking parameters was successful.

UnexpectedFeedback

Enumeration name:

UnexpectedFeedback

Enumeration value:

28

Description:

A feedback value was invalid.

Retrieving the tracking parameters was unsuccessful. A feedback value was invalid.