 |
UA Bundle SDK .NET
2.4.0.361
|
|
UA Bundle SDK .NET
2.4.0.361
|
The interface for methods implemented on the AcknowledgeableConditionModel object. More...
Inherits UnifiedAutomation.UaServer.IConditionMethods.
Inherited by UnifiedAutomation.UaServer.BaseNodeManager.
Public Member Functions | |
| StatusCode | Acknowledge (RequestContext context, AcknowledgeableConditionModel model, byte[] EventId, LocalizedText Comment) |
| Used to acknowledge an Event Notification for a Condition instance state where AckedState was set to FALSE. More... | |
| StatusCode | Confirm (RequestContext context, AcknowledgeableConditionModel model, byte[] EventId, LocalizedText Comment) |
| Used to confirm an Event Notification for a Condition instance state where ConfirmedState was set to FALSE. More... | |
 Public Member Functions inherited from UnifiedAutomation.UaServer.IConditionMethods | |
| StatusCode | AddComment (RequestContext context, ConditionModel model, byte[] EventId, LocalizedText Comment) |
| Used to apply a comment to a specific state of a Condition instance. More... | |
| StatusCode | Disable (RequestContext context, ConditionModel model) |
| Used to change a Condition instance to the Disabled state. More... | |
| StatusCode | Enable (RequestContext context, ConditionModel model) |
| Used to change a Condition instance to the enabled state. More... | |
The interface for methods implemented on the AcknowledgeableConditionModel object.
| StatusCode UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods.Acknowledge | ( | RequestContext | context, |
| AcknowledgeableConditionModel | model, | ||
| byte[] | EventId, | ||
| LocalizedText | Comment | ||
| ) |
Used to acknowledge an Event Notification for a Condition instance state where AckedState was set to FALSE.
Normally, the MethodId passed to the Call Service is found by browsing the Condition instance in the AddressSpace. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall allow Clients to call the Acknowledge Method by specifying ConditionId as the ObjectId and the well known NodeId of the Method declaration on the AcknowledgeableConditionType as the MethodId. The Method cannot be called on the AcknowledgeableConditionType Node.
| ResultCode | Description |
|---|---|
| Bad_ConditionBranchAlreadyAcked | The EventId does not refer to a state that needs acknowledgement. |
| Bad_EventIdUnknown | The specified EventId is not known to the Server. |
| Bad_NodeIdUnknown | The node id refers to a node that does not exist in the server address space. Used to indicate that the specified Condition is not valid or that the Method was called on the ConditionType Node. |
| context | |
| model | |
| EventId | EventId identifying a particular Event Notification. Only Event Notifications where AckedState/Id was FALSE can be acknowledged. |
| Comment | A localized text to be applied to the Condition. |
Implemented in UnifiedAutomation.UaServer.BaseNodeManager.
| StatusCode UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods.Confirm | ( | RequestContext | context, |
| AcknowledgeableConditionModel | model, | ||
| byte[] | EventId, | ||
| LocalizedText | Comment | ||
| ) |
Used to confirm an Event Notification for a Condition instance state where ConfirmedState was set to FALSE.
Normally, the MethodId passed to the Call Service is found by browsing the Condition instance in the AddressSpace. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall allow Clients to call the Confirm Method by specifying ConditionId as the ObjectId and the well known NodeId of the Method declaration on the AcknowledgeableConditionType as the MethodId. The Method cannot be called on the AcknowledgeableConditionType Node.
Method result codes:
| ResultCode | Description |
|---|---|
| Bad_ConditionBranchAlreadyConfirmed | The EventId does not refer to a state that needs confirmation. |
| Bad_EventIdUnknown | The specified EventId is not known to the Server. |
| Bad_NodeIdUnknown | The node id refers to a node that does not exist in the server address space. Used to indicate that the specified Condition is not valid or that the Method was called on the ConditionType Node. |
| context | |
| model | |
| EventId | EventId identifying a particular Event Notification. Only Event Notifications where ConfirmedState/Id was TRUE can be confirmed. |
| Comment | A localized text to be applied to the Conditions. |
Implemented in UnifiedAutomation.UaServer.BaseNodeManager.
