IF_TargetsHandlerEventsListener - OnRemoveTarget (Method)

Overview

Type:

Method

Available as of:

V1.4.1.0

This chapter provides information on:

oTask

oDescription

oInterface

oDiagnostic Messages

Task

Provides user-specific diagnostics when a target is removed from the list.

Description

The OnRemoveTarget method is called by the targets handler where the implementation of IF_TargetsHandlerEventsListener has been subscribed every time a target is removed from the list.

The following methods trigger the event:

oRemoveTarget

oRemoveAllTargets

oThe method is also triggered every time a target is automatically removed from the list. This can occur if FB_TargetsHandler is configured to remove the targets once they reach a maximum position (i_xAutoRemoveTargets input of the Configuration method set to TRUE).

The diagnostics provided as output depend on your specific implementation. They are ignored by the library.

Interface

Input

Data type

Description

i_stTarget

ST_RobotTarget

Robot target structure containing the information on the target that has been removed from the list.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic. A value unequal to GD.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 more detailed information on the diagnostic state.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

Ok

Ok

0

Ok

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Status Message: The method has been successfully called.