IF_CapsuleSetPointsRadius (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

This chapter provides information on:

Task

This method initializes the Capsule object using two points and a radius.

Description

The method can be called multiple times to reconfigure the object.

The following figure represents i_stPointA, i_stPointB and i_lrRadiusparameters of a Capsule object:

Interface

Access: PUBLIC

Input

Data type

Description

i_stPointA

SE_Math.ST_Vector3D

Point A Capsule object.

i_stPointB

SE_Math.ST_Vector3D

Point B Capsule object.

i_lrRadius

LREAL

Radius of the Capsule object.

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.