FB_RandomTargetsGenerator - GetTargetMatrixInPlaneRotationList (Method)

Overview

Type:	Method
Available as of:	V1.1.0.0

This chapter provides information on:

oTask

oDescription

oInterface

oDiagnostic Messages

Task

Retrieve a set of constraints for the generation of a matrix of targets.

Description

The method GetTargetMatrixInPlaneRotationList allows you to retrieve a set of constraints for the generation of a matrix of targets contained in a selected working plane.

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_udiNumberOfRows	UDINT	Number of rows of the matrix of targets.
q_udiNumberOfColumns	UDINT	Number of columns of the matrix of targets.
q_etPlane	ET_WorkingPlane	Selected working plane.
q_stMatrixOriginPosition	PDL.ST_Vector3D	Position of the origin of the matrix.
q_stMatrixElementStep	PDL.ST_Vector3D	Position steps along the X, Y and Z axes, used for the generation of the positions in the matrix.
q_alrRotationList	ARRAY [1... Gc_uiMaxNumberOfRotations] OF LREAL	List of possible rotations.
q_alrRotationProbabilityList	ARRAY [1... Gc_uiMaxNumberOfRotations] OF LREAL	List of probabilities related to the random selection of a rotation from the configured list.
q_etOrientationConvention	ROB.ET_OrientationConvention	Convention for the rotation angles of the orientation.
q_alrTargetTypeProbabilityList	ARRAY [1...Gc_uiMaxNumberOfTargetTypes] OF LREAL	Every index of this array is linked to a specific target type and every element contains the probability that a target of a certain target type is randomly generated.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	The parameters were successfully loaded.
ExecutionAborted	RandomTargetsTypeNotConfigured	64	The selected random target type was not configured.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The parameters was successfully loaded.

RandomTargetsTypeNotConfigured

Enumeration name:	RandomTargetsTypeNotConfigured
Enumeration value:	64
Description:	The desired target generation type was not configured.

Issue	Cause	Solution
Target generation type not configured.	The selected random target generation type was not configured.	Ensure to configure the required random target generation type with the method SetTargetMatrixInPlaneRotationList before calling the GetTargetMatrixInPlaneRotationList method.