This Method sets the Value of the ApplicationTag Variable. The security constraints defined in chapter 6.6 apply.

Signature

SetApplicationTag (

[in] 0:String ApplicationTag

);

Argument	Description
ApplicationTag	String containing the desired content of the ApplicationTag Variable.

The Method Result Codes (defined in Call Service) are defined in Table 15.

Table 15 – Possible Method Result Codes

Result Code	Description
Good	The Method execution was successful.
Bad_UserAccessDenied	The user has not the right to execute the Method.
Bad_InvalidArgument	The Server is not able to apply the name. The ApplicationTag string may be too long or may contain invalid characters. The server may also reject duplicates.
Bad_Locked	The EncoderChannelType Object is locked by a different Client’s Session.
Bad_RequiresLock	The EncoderChannelType Object is not locked. Clients must lock the EncoderChannelType Object before invoking a Method.
Bad_UnexpectedError	The server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure.

The EncoderProfileVersion Variable contains the encoder profile version of the Encoder Object the EncoderChannelType Object represents.

The EncoderChannelState Variable contains the representation of the G1_ZSW Signal as EncoderStateEnumeration.

The Lock Object ensures exclusive Method call for one Client. The Client locks the EncoderChannelType Object by invoking the InitLock Method of the Lock Object. The Client invokes ExitLock to release the lock.

The scope of the lock comprises all components except the EncoderProbeType Objects providing a LatchStart Method. These “controllable” probes have their own Lock Object and Clients shall be able to lock the EncoderProbeType Object separately and to invoke the LatchStart Method although the parent EncoderChannelType Object is locked.

Signal Variables

The following Variables represent the Standard Signals as defined in [ENCP], chapter 5.6.1. The supported Standard Signals are determined by the configured Standard Telegram. The Server shall provide the Variables representing the Standard Signals of the configured Standard Telegram.

The NIST_A Variable represents the “speed actual value” 16-bit signal encoded as 0:UInt16 (See [ENCP], Table 13, Signal No. 6). Mandatory for Class 4 Encoders.

The NIST_B Variable represents the “speed actual value” 32-bit signal encoded as 0:UInt32 (See [ENCP], Table 13, Signal No. 8). Mandatory for Class 2 Encoders.

The G1_STW Variable represents the “Sensor 1 control word” 16-bit signal encoded as 0:UInt16 (See [ENCP], Table 13, Signal No. 9). Mandatory for Class 3 and Class 4 Encoders.

The G1_ZSW Variable represents the “Sensor 1 status word” 16-bit signal encoded as 0:UInt16 (See [ENCP], Table 13, Signal No. 10). Mandatory for Class 3 and Class 4 Encoders.

The G1_XIST1 Variable represents the “Sensor 1 position actual value 1” 32-bit signal encoded as 0:UInt32 (See [ENCP], Table 13, Signal No. 11). Mandatory for Class 3 and Class 4 Encoders.

The G1_XIST2 Variable represents the “Sensor 1 position actual value 2” 32-bit signal encoded as 0:UInt32 (See [ENCP], Table 13, Signal No. 12). Mandatory for Class 3 and Class 4 Encoders.

The G1_XIST3 Variable represents the “Sensor 1 position actual value 3” 64-bit signal encoded as 0:UInt64 (See [ENCP], Table 13, Signal No. 39).

The STW2_ENC Variable represents the “Encoder control word 2” 16-bit signal encoded as 0:UInt16 (See [ENCP], Table 13, Signal No. 80). Mandatory for Class 1, Class2, Class 3 and Class 4 Encoders.

The ZSW2_ENC Variable represents the “Encoder status word 2” 16-bit signal encoded as 0:UInt16 (See [ENCP], Table 13, Signal No. 81). Mandatory for Class 1, Class2, Class 3 and Class 4 Encoders.

The G1_XIST_PRESET_B Variable represents the “Encoder preset control word 31 bit with trigger bit included” signal encoded as 0:UInt32 (See [ENCP], Table 13, Signal No. 82). Mandatory for Class 1 and Class2 Encoders.

The G1_XIST_PRESET_C Variable represents the “Encoder preset control word 64 bit” signal encoded as 0:UInt64 (See [ENCP], Table 13, Signal No. 83).

The G1_XIST_PRESET_B1 Variable represents the “Encoder preset control word 32 bit” signal encoded as 0:UInt32 (See [ENCP], Table 13, Signal No. 84). Mandatory for Class 1 and Class2 Encoders.

Measurement / Actual Values

The Position Variable contains the current Encoder’s position encoded as 0:Double data type. The Position Variable shall be linked to the Signal Variables representing the current position (G1_XIST1, G1_XIST2, G1_XIST3) that are part of the configured Standard Telegram using a 0:RepresentsSameEntityAs Reference.

The Velocity Variable contains the current Encoder’s velocity encoded as 0:Float data type. If a NIST_A or a NIST_B Signal Variable is part of the Information Model, the Velocity Variable shall be linked to the source Signal Variable using a 0:RepresentsSameEntityAs Reference.

The Acceleration Variable contains the currents Encoder’s rate of velocity change encoded as 0:Float data type.

The PositionSensorSignalValue Variable contains the Encoder’s position Signal encoded as numeric data type. Dependent on Encoder resolution and configured Standard Telegram number, the data type may be 0:UInt32 or 0:UInt64.

The Temperature Variable contains the Encoder’s temperature measurement value encoded as 0:Float data type.

Configuration

The SensorConfig Object contains sensor related configuration settings of the Encoder Object. See section 7.8 for details.

The AxisConfig Object contains Encoder axis related configuration settings of the Encoder Object. See section 7.6 for details.

The ControlConfig Object contains control related configuration settings of the Encoder Object. See section 7.7 for details.

Sensor & Probes

The Sensor Object offers Variables and Methods for sensor related preset- and latch control. See section 7.2 for details.

The Probes Object has References to EncoderProbeType Objects offering Variables and Methods for probes related data and latch control. See section 7.3 for details.

Diagnosis

The Logbook Object contains a representation of the Encoder Object’s fault buffer. See section 7.5 for details.

The Server might provide diagnosis data by sending EncoderDiagnosisEventType Events.