FC_PoseMatrixToPose - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Description

Given an input pose matrix and an orientation convention, the function evaluates the representation of such pose as position and roll, pitch and yaw angles. The orientation of the resulting pose is described accordingly to i_etOrientationConvention.

NOTE: There is no internal verification about i_stPoseMatrix being a valid pose matrix.

Interface

Input

Data type

Description

i_stPoseMatrix

SE_MATH.ST_Matrix4D

A 4D matrix describing a Cartesian pose.

i_etOrientationConvention

ET_OrientationConvention

Orientation convention used to evaluate the resulting 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

ST_CartesianPose

The function returns a position and roll, pitch and yaw representation of the orientation starting from a 4D matrix pose.

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