FB_RandomPoseGenerator - GetPoseInPlane (Method)

Overview

Type:

Method

Available as of:

V1.1.0.0

This chapter provides information on:

oTask

oDescription

oInterface

oDiagnostic Messages

Task

Retrieve the constraints previously set.

Description

The method GetPoseInPlane allows you to retrieve the constraints previously set by you.

Interface

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal 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 more detailed information on the diagnostic state.

q_etPlane

ET_WorkingPlane

Selected working plane (for example, XY, XZ, YZ).

q_stMinPosition

PDL.ST_Vector3D

Minimum position value that a generated pose can take.

q_stMaxPosition

PDL.ST_Vector3D

Maximum position value that a generated pose can take.

q_lrMinRotation

LREAL

Minimum rotation angle about an axis normal to the selected plane used to generate the pose.

q_lrMaxRotation

LREAL

Maximum rotation angle about an axis normal to the selected plane used to generate the pose.

q_etOrientationConvention

ROB.ET_OrientationConvention

Convention for the rotation angles of the orientation.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

ExecutionAborted

RandomPoseTypeNotConfigured

64

The pose generation type was not configured.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

The constraints were successfully retrieved.

RandomPoseTypeNotConfigured

Enumeration name:

RandomPoseTypeNotConfigured

Enumeration value:

52

Description:

The constraints for the selected random pose type are not configured.

Issue

Cause

Solution

Pose type not configured.

The selected random pose type was not configured.

Ensure to configure the required random target generation type with the method SetPoseInPlane before calling the GetPoseInPlane method.