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)
	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...

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
	)

Used to apply a comment to a specific state of a Condition instance.

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 AddComment Method by specifying ConditionId as the ObjectId and the well known NodeId of the Method declaration on the ConditionType as the MethodId. The Method cannot be called on the ConditionType Node.

Method result codes:

ResultCode	Description
Bad_MethodInvalid	The method id does not refer to a method for the specified object. The addressed Condition does not support adding comments.
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.

Parameters

context
model
EventId	The identifier for the event to comment.
Comment	The comment to add to the condition.

Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

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

Used to change a Condition instance to the Disabled state.

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 Disable Method by specifying ConditionId as the ObjectId and the well known NodeId of the Method declaration on the ConditionType as the MethodId.

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
	)

Used to change a Condition instance to the enabled state.

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 Enable Method by specifying ConditionId as the ObjectId and the well known NodeId of the Method declaration on the ConditionType as the MethodId.

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:

• C:/work/uasdknet/src/UaServer/Models/UaBaseClasses.cs