FB_TeachingLinearMotionSystem - GetConfiguration (Method)

Overview

Type:

Method

Available as of:

V1.8.0.0

This chapter provides information on:

Task

Gets the configuration of a teaching procedure.

Description

The method GetConfiguration(...) is used to get the basic configuration of a teaching procedure.

Access: PUBLIC

Interface

Output

Data type

Description

q_xError

BOOL

TRUE: An error occurred during last command. For more information refer also to q_etResult and q_sResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information.

If q_xError = FALSE, then q_etResult provides status information.

If q_xError = TRUE, then q_etResult provides diagnostic/error information.

The enumeration ET_Result contains the possible values of the POU operation results.

q_sResultMsg

STRING[80]

Provides additional information about the current status of the POU.

q_stReferenceSystemBasePose

ST_CartesianPose

The cartesian pose of the system used as reference for the teaching. This pose refers either to the robot or to the other system involved in the teaching, as defined by the input i_xIsRobotReferenceSystem.

q_xIsRobotReferenceSystem

BOOL

A procedure is always performed between a robot and another system.

TRUE: The input i_stReferenceSystemBasePose is the global pose of the robot and the pose estimated by the procedure is the one of the other system.

FALSE: The input i_stReferenceSystemBasePose is the pose of the other system and the pose estimated by the procedure is the one of the robot.

q_ifRobotFeedback

ROB.IF_RobotFeedback

IF_RobotFeedback interface of a robot.

Refer to Robotic Library - IF_Feedback.

q_ifRobotConfigurationReadOnly

ROB.IF_RobotConfigurationReadOnly

IF_ConfigurationReadOnly interface of a robot.

Refer to Robotic Library - IF_RobotConfigurationReadOnly.

Diagnostic Messages

q_xError

q_etResult

Enumeration value of q_etResult

Description

FALSE

Ok

0

Ok

TRUE

NotConfigured

29

The function block is not configured.

NotConfigured

Enumeration name:

NotConfigured

Enumeration value:

29

Description:

The function block is not configured.

Issue

Cause

Solution

Not possible to get the configuration.

The function block is not configured.

Ensure to call the Configuration method successfully before calling this method.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Status message: Adding a new sample to the active set was successful.