IF_TargetsHandler - SetTargetOwner (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

oTask

oDescription

oInterface

oDiagnostic Messages

Task

Sets the owner of a target.

Description

The method SetTargetOwner allows you to set the owner of a target. This information is typically used in multirobot applications to specify which robot is allowed to process a target.

Interface

Input	Data type	Description
i_udiListIndex	UDINT	The index of the target to be removed from the list.
i_etRobotId	ET_SystemEntity	The identifier of the robot that processes the target.

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.

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
ExecutionAborted	NotConfigured	101	The function block is not configured yet.
InputParameterInvalid	ListIndexInvalid	112	The provided list index is not referring to a valid target in the list.
InputParameterInvalid	ListIndexRange	111	The provided index is either zero or greater than the maximum list size.
InputParameterInvalid	RobotIdInvalid	120	A provided robot ID has an invalid value.

ListIndexInvalid

Enumeration name:	ListIndexInvalid
Enumeration value:	112
Description:	The provided list index is not referring to a valid target in the list.

Issue	Cause	Solution
The owner has not been assigned.	The targets handler does not contain a target with the provided index.	Ensure that a target with index i_udiListIndex is contained in the list.

ListIndexRange

Enumeration name:	ListIndexRange
Enumeration value:	111
Description:	The provided index is either zero or greater than the maximum list size.

Issue	Cause	Solution
The owner has not been assigned.	The value of the index is out of range.	The value of the index must be within the range [1...Gc_udiMaxNumberOfTargets].

NotConfigured

Enumeration name:	NotConfigured
Enumeration value:	101
Description:	The function block is not configured yet.

Issue	Cause	Solution
The owner has not been assigned.	The Configuration method has not been called yet.	Ensure that the Configuration method has been successfully called before calling this method.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

Status Message: The owner has been successfully set.

RobotIdInvalid

Enumeration name:	RobotIdInvalid
Enumeration value:	120
Description:	A provided robot ID has an invalid value.

Issue	Cause	Solution
The owner has not been assigned.	i_etRobotId does not contain a valid robot ID.	Verify that the robot identifier is either within the range [ET_SystemEntity.Robot1...ET_SystemEntity.Robot10] or is equal to ET_SystemEntity.None.