FB_EntitiesHandler - CalcEntityPoseInEntitySystem (Method)

Overview

Type:

Method

Available as of:

V1.6.0.0

This chapter provides information on:

Task

Evaluates the cartesian pose.

Description

The method CalcEntityPoseInEntitySystem calculates the cartesian pose in the base frame of a source entity to a cartesian pose in the base frame of a target entity.

Access: PUBLIC

Interface

Input

Data type

Description

i_etSourceSystemId

ET_SystemEntity

An ID used to unequivocally identify an entity in the system. Admissible values are in the ranges:

  • ET_SystemEntity.Conveyor1...ET_SystemEntity.Conveyor30 and

  • ET_SystemEntity.Robot1...ET_SystemEntity.Robot10 and

  • ET_SystemEntity.TargetGenerator1...ET_SystemEntity.TargetGenerator30

    and
  • ET_SystemEntity.Global

I_stSourcePose

ST_CartesianPose

A cartesian pose in the i_etSourceSystem base frame that should be calculated to the base frame of a target system.

i_etTargetSystemId

ET_SystemEntity

An ID used to unequivocally identify an entity in the system. Admissible values are in the ranges:

  • ET_SystemEntity.Conveyor1...ET_SystemEntity.Conveyor30 and

  • ET_SystemEntity.Robot1...ET_SystemEntity.Robot10 and

  • ET_SystemEntity.TargetGenerator1...ET_SystemEntity.TargetGenerator30 and

  • ET_SystemEntity.Global

Return Value

Data type

Description

ST_CartesianPose

Refer to ST_CartesianPose.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

OK

0

Ok

InputParameterInvalid

ConveyorIdUnknown

133

A provided conveyor ID is invalid.

InputParameterInvalid

RobotIdUnknown

130

A provided robot ID is invalid.

InputParameterInvalid

TargetGeneratorIdUnknown

174

A provided target generator type is invalid.

InputParameterInvalid

EntityIdInvalid

132

A provided entity ID is invalid

InputParameterInvalid

OrientationConventionInvalid

38

Invalid orientation convention.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

ConveyorIdUnknown

Enumeration name:

ConveyorIdUnknown

Enumeration value:

133

Description:

A provided conveyor ID is invalid.

Issue

Cause

Solution

The cartesian pose has not been successfully evaluated.

The value provided at i_etSourceSystemId or i_etTargetSystemId was not valid.

The conveyor ID provided at i_etSourceSystemId or i_etTargetSystemId is indeterminable.

Ensure that the value of i_etSourceSystemId or i_etTargetSystemId refers to a previously configured conveyor.

RobotIdUnknown

Enumeration name:

RobotIdUnknown

Enumeration value:

130

Description:

A provided robot ID is invalid.

Issue

Cause

Solution

The cartesian pose has not been successfully evaluated.

The value provided at i_etSourceSystemId or i_etTargetSystemId was not valid.

The robot ID provided at i_etSourceSystemId or i_etTargetSystemId is indeterminable.

Ensure that the value of i_etSourceSystemId or i_etTargetSystemId refers to a previously configured robot.

TargetGeneratorIdUnknown

Enumeration name:

TargetGeneratorIdUnknown

Enumeration value:

174

Description:

A provided target generator type is invalid.

Issue

Cause

Solution

The cartesian pose has not been successfully evaluated.

The value provided at i_etSourceSystemId or i_etTargetSystemId was not valid.

The target generator ID provided at i_etSourceSystemId or i_etTargetSystemId is indeterminable.

Ensure that the value of i_etSourceSystemId or i_etTargetSystemId refers to a previously configured target generator.

EntityIdInvalid

Enumeration name:

EntityIdInvalid

Enumeration value:

132

Description:

A provided entity ID is invalid

Issue

Cause

Solution

The cartesian pose has not been successfully evaluated.

The value provided at i_etSourceSystemId or i_etTargetSystemId was not valid.

Ensure that the value of i_etSourceSystemId or i_etTargetSystemId refers to a previously configured system.

OrientationConventionInvalid

Enumeration name:

OrientationConventionInvalid

Enumeration value:

38

Description:

Invalid orientation convention.

Issue

Cause

Solution

The cartesian pose has not been successfully evaluated.

The value provided at i_stSourcePose.etOrientationConvention was not valid.

i_stSourcePose.etOrientationConvention contains an invalid orientation convention.

Provide a valid value for the orientation convention. Admissible values are:

  • ROB.ET_OrientationConvention.XYZ

  • ROB.ET_OrientationConvention.ZYX