FC_PoseToString - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Description

Given a Cartesian pose structure, the function returns a string structured as P(X, Y, Z), O(X, Y, Z), ZYX.

During the conversion from LREAL to STRING the values are truncated to the third decimal.

The orientation convention is represented as a string with the name of one of the possible elements of ET_OrientationConvention.

Interface

Input

Data type

Description

i_stPose

ST_CartesianPose

A Cartesian pose.

Output

Data type

Description

q_xError

BOOL

If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information.

If q_xError = FALSE, then q_etResult provides status information.

If q_xError = TRUE, then q_etResult provides diagnostic/error information.

The enumeration ET_Result contains the possible values of the POU operation results.

q_sResultMsg

STRING[80]

Provides additional information about the current status of the POU.

Return Value

Data type

Description

STRING[255]

The function returns a string structured as P(X, Y, Z), O(X, Y, Z), ZYX.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

Ok

0

Success

TRUE

OrientationConventionInvalid

11

The selected orientation convention is invalid.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

OrientationConventionInvalid

Enumeration name:

OrientationConventionInvalid

Enumeration value:

11

Description:

The selected orientation convention is invalid.

Issue

Cause

Solution

Evaluation of the orientation was not successful.

i_etOrientationConvention contains an invalid value.

Provide one of the following values:

  • ET_OrientationConvention.ZYX

  • ET_OrientationConvention.XYZ

  • ET_OrientationConvention.ZXY