IF_EntitiesHandler - GetTargetGenerator (Method)

Overview

Type:	Method
Available as of:	V1.6.0.0

This chapter provides information on:

Task
Description
Interface
Return Value
Diagnostic Messages

Task

Get information on the target generator.

Description

The method GetTargetGenerator is used to retrieve the information on a target generator previously stored inside the internal list of the function block.

Interface

Access: PUBLIC

Input	Data type	Description
i_etSystemId	ET_SystemEntity	An ID used to unequivocally identify a target generator. Admissible values are in the range SERT.ET_SystemEntity.TargetGenerator1... SERT.ET_SystemEntity.TargetGenerator30.

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.

Return Value

Data type	Description
ST_TargetGeneratorEntityData	Stores information for a target generator. Refer to ST_TargetGeneratorEntityData.

Data type

Description

ST_TargetGeneratorEntityData

Stores information for a target generator.

Refer to ST_TargetGeneratorEntityData.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value of q_etDiagExt	Description
Ok	Ok	0	Ok
InputParameterInvalid	TargetGeneratorIdInvalid	171	A provided target generator ID is invalid.
InputParameterInvalid	TargetGeneratorIdUnKnown	174	A provided target generator type is invalid.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Success

TargetGeneratorIdInvalid

Enumeration name:	TargetGeneratorIdInvalid
Enumeration value:	171
Description:	A provided target generator ID is invalid.

Issue	Cause	Solution
A target generator has not been retrieved successfully from the list.	i_etSystemId contains an invalid value.	Ensure that the ID is in the range SERT.ET_SystemEntity.TargetGenerator1...SERT.ET_SystemEntity.TargetGenerator30.

TargetGeneratorIdUnKnown

Enumeration name:	TargetGeneratorIdUnKnown
Enumeration value:	174
Description:	A provided target generator type is invalid.

Issue	Cause	Solution
A tracking system has not been retrieved successfully from the list.	i_etSystemId contains an invalid ID.	Ensure that the target generator Id refers to a previously configured target generator.