IF_TargetsHandler - Reset (Method)

Overview

Type:

Method

Available as of:

V1.6.0.0

This chapter provides information on:

Task

Reset the configuration of the function block.

Description

The method Reset resets the configured parameters for the function block.

The result of a Reset call:

  • The existing targets are removed from the function block; therefore, the property udiNumberOfTargets is set to zero.

  • The statistics are cleared; therefore, the property udiNumberOfLostTargets is set to zero.

  • The number of configured slots is reset; therefore, the property udiNumberOfSlots is set to zero.

  • The property etTrackingSystemID is set to ROB.ET_CoordinateSystem.None.

  • The properties udiFirstListIndex and udiLastListIndex are set to zero.

  • The subscribed events listeners are removed.

  • The property lrEncoderRolloverValue is set to zero.

  • The property xConfigured is set to FALSE.

Interface

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic:

  • q_etDiag = ET_Diag.Ok -> Status message

  • q_etDiag <> ET_Diag.Ok -> Diagnostic message

q_sMsg

STRING(80)

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

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value of q_etDiagExt

Description

Ok

Ok

0

Ok

ExecutionAborted

UpdateTargetsActive

109

An update of the target handler targets is running and some method cannot be called.

ExecutionAborted

NotConfigured

101

The function block has not been configured yet.

OK

Enumeration name:

Ok

Enumeration value:

0

Description:

Success

UpdateTargetsActive

Enumeration name:

UpdateTargetsActive

Enumeration value:

109

Description:

An update of the target handler targets is running and some method cannot be called.

Issue

Cause

Solution

The function block could not be reset.

An UpdateTargets call is active.

Make sure that there are no active calls of the UpdateTargets method before calling the Reset method.

NotConfigured

Enumeration name:

NotConfigured

Enumeration value:

101

Description:

The function block is not configured yet.

Issue

Cause

Solution

The function block could not be reset.

The function block is not configured yet and cannot be reset.

Make a successful configuration of the function block before calling the Reset method