IF_Motion - GetVelocityLimitation (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Reading the values of the configured velocity limitation for the movement of the carrier.

Description

The method GetVelocityLimitation returns the values configured for the velocity limitation in the method outputs, provided that a velocity limitation is active. In case the velocity limitation is not configured for the carrier, the outputs are set as follows:

Output

Value

q_xVelLimitActive

FALSE

q_lrVelocity

-1

q_lrStartPosition

-1

q_lrEndPosition

-1

Inputs

The method has no inputs.

Outputs

Output

Data type

Unit

Description

q_xVelLimitActive

BOOL

Indicates TRUE if velocity limitation is configured for the carrier.

q_lrVelocity

LREAL

mm/s

Indicates the configured velocity of a carrier at q_lrStartPosition.

q_lrStartPosition

LREAL

mm

Indicates the configured start position that the carrier must have before velocity limitation.

q_lrEndPosition

LREAL

mm

Indicates the configured end position that the carrier must have after velocity limitation.

q_lrGap

LREAL

mm

Indicates the configured gap that the carrier must have in the section of the track with defined velocity limitation.

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.