IF_TeachingCartesianPose - GetSample (Method)

Overview

Type:

Method

Available as of:

V1.8.0.0

This chapter provides information on:

Task

Gets a previously stored sample.

Description

With the method GetSample(...), a previously stored sample at the selected set and sample index is returned.

Access: PUBLIC

Interface

Input

Data type

Description

i_udiSetIndex

UDINT

Index of the set where the sample is stored.

i_udiSampleIndex

UDINT

Index of the sample within the selected set.

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_stTCPPosition

SE_MATH.ST_Vector3D

TCP position stored at the selected set and sample indices.

q_stTargetPosition

SE_MATH.ST_Vector3D

Target position stored at the selected set and sample indices.