FC_OrientationToOrientation - General Information

Overview

Type:

Function

Available as of:

V1.0.2.0

Versions:

Current version

This chapter provides information on:

Description

Given an input orientation, a source, and a target orientation convention, the function evaluates an orientation described as roll, pitch and yaw angles following the provided target orientation convention.

Interface

Input

Data type

Description

i_stOrientation

SE_MATH.ST_Vector3D

An orientation described as roll, pitch and yaw angles using the convention described by i_etSourceOrientationConvention.

i_etSourceOrientationConvention

ET_OrientationConvention

Orientation convention to consider for i_stOrientation.

i_etTargetOrientationConvention

ET_OrientationConvention

Orientation convention used to evaluate the resulting orientation.

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

SE_MATH.ST_Vector3D

The function returns the orientation described as roll, pitch and yaw angles and represents the input orientation using the convention described by i_etTargetOrientationConvention.

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

The orientation convention was not set successfully.

The value provided at the input i_etSourceOrientationConvention is invalid.

Ensure that a valid value is transferred at the input i_etSourceOrientationConvention.

Valid values are:

  • ET_OrientationConvention.XYZ

  • ET_OrientationConvention.ZYX

  • ET_OrientationConvention.ZXY

For further information, refer to ET_OrientationConvention.

The value provided at the input i_etTargetOrientationConvention is invalid.

Ensure that a valid value is transferred at the input i_etTargetOrientationConvention.

Valid values are:

  • ET_OrientationConvention.XYZ

  • ET_OrientationConvention.ZYX

  • ET_OrientationConvention.ZXY