The EncoderControlConfigType Object provides Properties for configuring the alarm channel, the effect of preset functions and the tolerated Sign-Of-Life failures.
Table 30 – EncoderControlConfigType Definition
|
Attribute |
Value |
||||
|
BrowseName |
EncoderControlConfigType |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseObjectType defined in OPC 10000-5. |
|||||
|
0:HasProperty |
Variable |
AlarmChannelControl |
EncoderAlarmChannelControlEnumeration |
0:PropertyType |
O, RO |
|
0:HasProperty |
Variable |
XIST1PresetControl |
EncoderPresetControlEnumeration |
0:PropertyType |
O, RO |
|
0:HasProperty |
Variable |
SignOfLifeFailuresTolerated |
0:UInt16 |
0:PropertyType |
O, RO |
|
0:HasComponent |
Method |
SetControlConfig |
|
|
O |
|
Conformance Units |
|||||
|
PNENC Config Readable |
|||||
|
PNENC Config Writable |
|||||
The AlarmChannelControl Variable contains the Encoder’s configured alarm channel setting encoded as EncoderAlarmChannelControlEnumeration.
The XIST1PresetControl Variable contains the Encoder’s configured preset control setting for the G1_XIST1 Signal encoded as EncoderPresetControlEnumeration. If the G1_XIST1 Variable is part of the Information Model, XIST1 preset control setting is always available as Property of the G1_XIST1 Variable.
The SignOfLifeFailuresTolerated contains the Encoder’s configured setting for the number of allowed failures of the master’s sign of life.
This Method sets the Value of components of the ControlConfig Object to the desired value. The security constraints defined in chapter 6.6 apply. Clients must also have locked the parent EncoderChannelType Object before invoking the Method.
Signature
SetControlConfig (
[in] 0:KeyValuePair[] ControlConfigParameters,
[out] 0:KeyValuePair[] ControlConfigParametersResult
);
|
Argument |
Description |
|
ControlConfigParameters |
Array of 0:KeyValuePair structures containing the desired settings. The key field of each structure contains the BrowseName of one component of the ControlConfig Object. The value field contains the desired value to set for this component and must have the same DataType. |
|
ControlConfigParametersResult |
Array of 0:KeyValuePair structures. The array shall be empty if successful. The array shall contain one element for each failed setting and the Result Code shall be Uncertain (See Table 31). The key field of each structure contains the BrowseName of the component of the ControlConfig Object for which the setting failed. The value field is encoded as EncoderConfigParameterResultEnumeration and contains one of the following values: INVALID:The value is rejected by the Server. NOT_SUPPORTED: The component with the specified BrowseName does not exist. READ_ONLY:The value cannot be changed. |
The Method Result Codes (defined in Call Service) are defined in Table 31. The requested Property changes are applied if a Result Code with severity Good is returned. Otherwise, no Property is changed.
Table 31 – Possible Method Result Codes
|
Result Code |
Description |
|
Good |
The Method execution was successful. The ControlConfigParametersResult array is empty. |
|
Uncertain |
The Server is not able to apply the requested changes due to invalid parameters. The ControlConfigParametersResult array is not empty. |
|
Bad_ConfigurationError |
The set of parameters passed in the ControlConfigParameters array is not consistent. |
|
Bad_InvalidArgument |
The ControlConfigParameters argument array is empty or there are member type mismatches. |
|
Bad_Locked |
The parent EncoderChannelType Object is locked by a different Client’s Session. |
|
Bad_RequiresLock |
The parent EncoderChannelType Object is not locked. Clients must lock the parent EncoderChannelType Object before invoking a Method. |
|
Bad_UserAccessDenied |
The user has not the right to execute the 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. |
If the desired settings do not deviate from the actual settings, the Method shall do nothing and return Good as result code.