FB_CollisionHandlerSCARA4Ax - GetParameters (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

This chapter provides information on:

Task

Returns a set of configured parameters.

Description

This method returns a set of configured parameters that describe a SCARA4Ax robot from both a kinematic and geometric point of view.

Interface

The function block implements the interface IF_CollisionHandlerSCARA4Ax.

Access: PUBLIC

Output

Data type

Description

q_xError

BOOL

The output is set to TRUE if an error has been detected during the execution.

q_etResult

ET_Result

POU-specific output on the diagnostic; q_xError = FALSE -> Status message; q_xError = TRUE -> Diagnostic message.

q_sResultMsg

STRING(80)

Event-triggered message that gives additional information on the diagnostic state.

Return Value

Data type

Description

ST_SCARA4AxParameters

Refer to ST_SCARA4AxParameters.

Diagnostic Messages

q_xError

q_etResult

Enumeration value

Description

FALSE

OK

0

Success

TRUE

NotConfigured

26

The object is not configured.

OK

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

NotConfigured

Enumeration name:

NotConfigured

Enumeration value:

26

Description:

The object is not configured.

Issue

Cause

Solution

Could not get the parameters.

The collision handler has not been configured, meaning that xConfigured = FALSE.

Make a successful call of SetParameters before calling this method.