IF_TargetsHandler - SetEncoderPositionToSourcePosition (Method)

Overview

Type:	Method
Available as of:	V1.4.1.0

This chapter provides information on:

Task
Description
Interface
Diagnostic Messages

Task

Sets the position of the logical encoder linked to the targets handler to one of the configured sources.

Description

The method SetEncoderPositionToSourcePosition allows you to set the position of the logical encoder linked to the targets handler to one of the configured sources. This is typically required after performing a homing procedure on the source.

Interface

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.
	UpdateTargetsActive	109	An update of the target handler target is running and some methods cannot be called.
	VelocitySourceInvalid	102	The configured velocity source is not valid.

NotConfigured

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

Issue	Cause	Solution
It is not possible to set the encoder position.	The Configuration method has not been called yet.	Ensure that the Configuration method has been successfully called before calling this method.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Success

Status Message: The encoder position has been successfully set.

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
It is not possible to set the encoder position.	It is not possible to set the encoder position while the UpdateTargets method is running.	Ensure that the UpdateTargets method is not running before calling this method.

VelocitySourceInvalid

Enumeration name:	VelocitySourceInvalid
Enumeration value:	102
Description:	The configured velocity source is not valid.

Issue	Cause	Solution
It is not possible to set the encoder position.	The velocity source, does not provide a position.	Ensure that the configured velocity source also provides a position.