IF_TargetsHandler - ConfigureSlotList (Method)

Overview

Type:

Method

Available as of:

V1.4.1.0

This chapter provides information on:

Task

Describes how slots are geometrically displaced with reference to a common origin referred to the container target.

Description

The method ConfigureSlotList is used to describe how slots are geometrically displaced with reference to a common origin referred to the container target. Considering, for example, a tray containing a set of slots, this method would be used to define the relative position and orientation of each slot with reference to the origin of the trace.

If the configured number of slots is greater than zero, each target stored inside the targets handler contains a list of i_uiNumberOfSlots slots that have a relative pose (referred to the origin of its container target) described by i_astSlotPosesList.

You can call the method ConfigureSlotList at any time but it is a prerequisite that the list is empty. In case of reconfiguration, first call the method RemoveAllTargets to empty the list and then call the method ConfigureSlotList.

Interface

Input

Data type

Description

i_uiNumberOfSlots

UINT

The number of slots to configure.

i_astSlotPosesList

ARRAY [1..Gc_uiMaxNumberOfSlots] OF ST_CartesianPose

The Cartesian poses of the slots to configure, referred to the origin of a container target.

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.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

Ok

Ok

0

Ok

ExecutionAborted

NumberOfTargetsInvalid

118

A method was called that requires the list of targets to be empty.

InputParameterInvalid

NumberOfSlotsRange

115

The number of slots is greater than the maximum allowed value Gc_udiMaxNumberOfSlots.

InputParameterInvalid

OrientationConventionInvalid

38

Invalid orientation convention.

NumberOfSlotsRange

Enumeration name:

NumberOfSlotsRange

Enumeration value:

115

Description:

The number of slots is greater than the maximum allowed value Gc_udiMaxNumberOfSlots.

Issue

Cause

Solution

The list of slots has not been successfully configured.

i_uiNumberOfSlots is greater than Gc_uiMaxNumberOfSlots.

Ensure that i_uiNumberOfSlotsGc_uiMaxNumberOfSlots.

NumberOfTargetsInvalid

Enumeration name:

NumberOfTargetsInvalid

Enumeration value:

118

Description:

A method was called that requires the list of targets to be empty.

Issue

Cause

Solution

The list of slots has not been successfully configured.

The method has been called while the list is not empty.

Ensure that the list of targets is empty before calling this method. To achieve this, you can call, for example, RemoveAllTargets.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

Status Message: The list of slots has been successfully configured.

OrientationConventionInvalid

Enumeration name:

OrientationConventionInvalid

Enumeration value:

38

Description:

Invalid orientation convention.

Issue

Cause

Solution

The list of slots has not been successfully configured.

One of the orientation convention values for the poses of i_astSlotPosesList is invalid.

Provide one of the permissible values of ROB.ET_OrientationConvention.

Refer to Robotic Library - ET_OrientationConvention.