.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods Interface Reference

The interface for methods implemented on the AcknowledgeableConditionModel object. More...

Inherits UnifiedAutomation.UaServer.IConditionMethods.

Inherited by UnifiedAutomation.UaServer.IAlarmConditionMethods.

Public Member Functions

StatusCode Acknowledge (RequestContext context, AcknowledgeableConditionModel model, byte[] EventId, LocalizedText Comment)
 Acknowledges an Event Notification for a Condition instance state where AckedState is FALSE. More...
 
StatusCode Confirm (RequestContext context, AcknowledgeableConditionModel model, byte[] EventId, LocalizedText Comment)
 Confirms 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)
 Applies a comment to a specific state of a Condition instance. More...
 
StatusCode Disable (RequestContext context, ConditionModel model)
 Changes a Condition instance to the Disabled state. More...
 
StatusCode Enable (RequestContext context, ConditionModel model)
 Changes a Condition instance to the enabled state. More...
 

Detailed Description

The interface for methods implemented on the AcknowledgeableConditionModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods.Acknowledge ( RequestContext  context,
AcknowledgeableConditionModel  model,
byte[]  EventId,
LocalizedText  Comment 
)

Acknowledges an Event Notification for a Condition instance state where AckedState is FALSE.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the Acknowledge method by specifying ConditionId. The method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

ResultCode Description
Bad_ConditionBranchAlreadyAcked The EventId does not refer to a state that needs acknowledgement.
Bad_MethodInvalid The method id does not refer to a method for the specified object or ConditionId.
Bad_EventIdUnknown The specified EventId is not known to the Server.
Bad_NodeIdInvalid The node id refers to a node that does not exist in the server address space. Used to indicate that the specified ObjectId is not valid or that the method was called on the ConditionType Node.
Parameters
context
model
EventIdEventId identifying a particular Event Notification. Only Event Notifications where AckedState/Id was FALSE can be acknowledged.
CommentA localized text to be applied to the Condition.
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods.Confirm ( RequestContext  context,
AcknowledgeableConditionModel  model,
byte[]  EventId,
LocalizedText  Comment 
)

Confirms an Event Notification for a Condition instance state where ConfirmedState was set to FALSE.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the Confirm method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectIf of the AcknowledgeableConditionType Node.

Method Result Codes

ResultCode Description
Bad_ConditionBranchAlreadyConfirmed The EventId does not refer to a state that needs confirmation.
Bad_MethodInvalid The method id does not refer to a method for the specified object or ConditionId.
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 ObjectId is not valid or that the method was called on the ConditionType Node.
Parameters
context
model
EventIdEventId identifying a particular Event Notification. Only Event Notifications where ConfirmedState/Id was TRUE can be confirmed.
CommentA localized text to be applied to the Conditions.
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.


The documentation for this interface was generated from the following file: