This Method sets the Value of Properties of the SensorConfig 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
SetSensorConfig (
[in] 0:KeyValuePair[] SensorConfigParameters,
[out] 0:KeyValuePair[] SensorConfigParametersResult
);
|
Argument |
Description |
|
SensorConfigParameters |
Array of 0:KeyValuePair structures containing the desired settings. The key field of each structure contains the BrowseName of one Property of the SensorConfig Object. The value field contains the desired value to set for this Property and must have the same DataType. |
|
SensorConfigParametersResult |
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 33). The key field of each structure contains the BrowseName of the Property of the SensorConfig 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 Property 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 33. The requested Property changes are applied if a Result Code with severity Good is returned. Otherwise, no Property is changed.
Table 33 – Possible Method Result Codes
|
Result Code |
Description |
|
Good |
The Method execution was successful. The SensorConfigParametersResult array is empty. |
|
Uncertain |
The Server is not able to apply the requested changes due to invalid parameters. The SensorConfigParametersResult array is not empty. |
|
Bad_ConfigurationError |
The set of parameters passed in the SensorConfigParameters array is not consistent. |
|
Bad_InvalidArgument |
The SensorConfigParameters 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.