IF_CarrierConfiguration - SetToolPivotPointOffset (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Setting the offset vector for the ToolPivotPoint.

Description

With the method SetToolPivotPointOffset, you can specify the offset vector from the center point of the carrier to the ToolPivotPoint. Thus, the ToolPivotPoint is defined by the ToolPivotPointOffset in relation to the center point of the carrier.

NOTE: For the definition of the ToolPivotPointOffset, only the X and Y axes of the 3-D vector are used. The value for the Z axis is 0.

For more information on the coordinate system of the carrier, refer to Carrier Coordinate System.

The ToolPivotPointOffset is used for synchronized movements of carriers with additional curve compensation (see StartCurveCompensationToCarrierInFront).

Inputs

Input	Data type	Description
i_stToolPivotPointOffset	PDL.ST_Vector3D	Specifies the ToolPivotPoint in relation to the center point of the carrier.

Outputs

Output	Data type	Description
q_xError	BOOL	Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING [255]	Provides additional diagnostic and status information as a text message.