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

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

Inherited by UnifiedAutomation.UaServer.BaseNodeManager, UnifiedAutomation.UaServer.IAcknowledgeableConditionMethods, and UnifiedAutomation.UaServer.IDialogConditionMethods.

Public Member Functions

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 ConditionModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IConditionMethods.AddComment ( RequestContext  context,
ConditionModel  model,
byte[]  EventId,
LocalizedText  Comment 
)

Applies a comment to a specific state of a Condition instance.

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 AddComment method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectId of the ConditionType Node.

Method Result Codes

ResultCode Description
Bad_MethodInvalid The method id does not refer to a method for the specified object. The MethodId provided does not correspond to the ObjectId provided.
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 Object is not valid or that the method was called on the ConditionType Node.
Parameters
context
model
EventIdThe identifier for the event to comment.
CommentThe comment to add to the condition.
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IConditionMethods.Disable ( RequestContext  context,
ConditionModel  model 
)

Changes a Condition instance to the Disabled state.

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 allow Clients to call the Disable method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectId of the ConditionType node.

Method Result Codes

ResultCode Description
Bad_ConditionAlreadyDisabled The addressed Condition is already disabled.
Parameters
context
model
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IConditionMethods.Enable ( RequestContext  context,
ConditionModel  model 
)

Changes a Condition instance to the enabled state.

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 allow Clients to call the Enable method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectId of the ConditionType Node. If the condition instance is not exposed, it may be difficult for a Client to determine the ConditionId for a disabled condition.

Method Result Codes

ResultCode Description
Bad_ConditionAlreadyEnabled The addressed Condition is already enabled.
Parameters
context
model
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.


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