OpcAcknowledgeableConditionNode Members

Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified as a child node of the parent node given.

C#

public OpcAcknowledgeableConditionNode(IOpcNode parent, OpcName name)

Parameters

parent IOpcNode

The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.

name OpcName

The OpcName through that the new acknowledgeable condition node can be accessed.

Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified as a child node of the parent node given.

C#

public OpcAcknowledgeableConditionNode(IOpcNode parent, OpcName name, OpcNodeId id)

Parameters

parent IOpcNode

The IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.

name OpcName

The OpcName through that the new acknowledgeable condition node can be accessed.

id OpcNodeId

The OpcNodeId through that the new acknowledgeable condition node can be identified and accessed.

Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified.

C#

public OpcAcknowledgeableConditionNode(OpcName name)

Parameters

name OpcName

The OpcName through that the new acknowledgeable condition node can be accessed.

Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified.

C#

public OpcAcknowledgeableConditionNode(OpcName name, OpcNodeId id)

Parameters

name OpcName

The OpcName through that the new acknowledgeable condition node can be accessed.

id OpcNodeId

The OpcNodeId through that the new acknowledgeable condition node can be identified and accessed.

Gets or sets a callback used to acknowledge the state of the condition node.

C#

public OpcAddCommentCallback AcknowledgeCallback { get; set; }

Property Value

OpcAddCommentCallback

A OpcAddCommentCallback used to acknowledge the state of the condition node. The value can also be a null reference (Nothing in Visual Basic).

Gets the OpcAddCommentMethodNode used to handle 'Acknowledge' method calls to acknowledge the state of the condition node.

C#

public OpcAddCommentMethodNode AcknowledgeNode { get; }

Property Value

OpcAddCommentMethodNode

An instance of the OpcAddCommentMethodNode class. Which uses an OpcAcknowledgeableConditionNode defined callback to acknowledge the state of the condition node.

Gets or sets a callback used to confirm the state of the condition node.

C#

public OpcAddCommentCallback ConfirmCallback { get; set; }

Property Value

OpcAddCommentCallback

A OpcAddCommentCallback used to confirm the state of the condition node. The value can also be a null reference (Nothing in Visual Basic).

Gets the OpcAddCommentMethodNode used to handle 'Confirm' method calls to confirm the state of the condition node.

C#

public OpcAddCommentMethodNode ConfirmNode { get; }

Property Value

OpcAddCommentMethodNode

An instance of the OpcAddCommentMethodNode class. Which uses an OpcAcknowledgeableConditionNode defined callback to confirm the state of the condition node.

Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.

C#

protected override OpcNodeId DefaultTypeDefinitionId { get; }

Property Value

OpcNodeId

The OpcNodeId of the type node from that this OpcInstanceNode has been created from. These type node defines the typical structure of an instance node of its type definition. If there exists no specific type definition node a null reference (Nothing in Visual Basic).

Gets a value indicating whether the condition requires acknowledgement for the reported condition state.

C#

public bool IsAcked { get; }

Property Value

Boolean

The value false if an acknowledgement is required; otherwise the value true.

Gets the OpcTwoStateVariableNode of the IsAcked property.

C#

public OpcTwoStateVariableNode IsAckedNode { get; }

Property Value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

Gets a value indicating whether the condition requires confirmation for the reported condition state.

C#

public bool IsConfirmed { get; }

Property Value

Boolean

The value false if an confirmation is required; otherwise the value true.

Gets the OpcTwoStateVariableNode of the IsConfirmed property.

C#

public OpcTwoStateVariableNode IsConfirmedNode { get; }

Property Value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

Acknowledges the state reported by an event notification which can be identified by the EventId using the specified context.

C#

public void Acknowledge(OpcContext context)

Parameters

context OpcContext

The OpcContext to use.

Exceptions

ArgumentNullException

The context is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Acknowledges the state reported by an event notification which can be identified by the eventId using the specified context.

C#

public void Acknowledge(OpcContext context, byte[] eventId, OpcText comment)

Parameters

context OpcContext

The OpcContext to use.

eventId Byte[]

The identifier which identifies the particular event notification its reported state for the condition node is to be commented.

comment OpcText

The text to apply on the condition state.

Exceptions

ArgumentNullException

The context or eventId is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Acknowledges the state reported by an event notification which can be identified by the EventId using the specified context.

C#

public void Acknowledge(OpcContext context, OpcText comment)

Parameters

context OpcContext

The OpcContext to use.

comment OpcText

The text to apply on the condition state.

Exceptions

ArgumentNullException

The context is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Acknowledges the state of the condition node.

C#

protected virtual OpcStatusCode AcknowledgeCore(OpcNodeContext<OpcConditionNode> context, byte[] eventId, OpcText comment)

Parameters

context OpcNodeContext<OpcConditionNode>

The OpcNodeContext´1 to use to acknowledge the state.

eventId Byte[]

The identifier identifying a particular event notification where a state was reported for a condition.

comment OpcText

A localized text to be applied to the condition.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the operation using the AcknowledgeCallback or Good if there is no custom callback routine defined.

Confirms the state reported by an event notification which can be identified by the EventId using the specified context.

C#

public void Confirm(OpcContext context)

Parameters

context OpcContext

The OpcContext to use.

Exceptions

ArgumentNullException

The context is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Confirms the state reported by an event notification which can be identified by the eventId using the specified context.

C#

public void Confirm(OpcContext context, byte[] eventId, OpcText comment)

Parameters

context OpcContext

The OpcContext to use.

eventId Byte[]

The identifier which identifies the particular event notification its reported state for the condition node is to be commented.

comment OpcText

The text to apply on the condition state.

Exceptions

ArgumentNullException

The context or eventId is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Confirms the state reported by an event notification which can be identified by the EventId using the specified context.

C#

public void Confirm(OpcContext context, OpcText comment)

Parameters

context OpcContext

The OpcContext to use.

comment OpcText

The text to apply on the condition state.

Exceptions

ArgumentNullException

The context is a null reference (Nothing in Visual Basic).

OpcException

The call failed (see exception details for more information).

Confirms the state of the condition node.

C#

protected virtual OpcStatusCode ConfirmCore(OpcNodeContext<OpcConditionNode> context, byte[] eventId, OpcText comment)

Parameters

context OpcNodeContext<OpcConditionNode>

The OpcNodeContext´1 to use to confirm the state.

eventId Byte[]

The identifier identifying a particular event notification where a state was reported for a condition.

comment OpcText

A localized text to be applied to the condition.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the operation using the ConfirmCallback or Good if there is no custom callback routine defined.

Creates a new instance of the OpcAcknowledgeableConditionNode using the same Id and Name as this node.

C#

protected override OpcConditionNode CreateBranchCore()

Returns

OpcConditionNode

A new instance of the OpcAcknowledgeableConditionNode identifiable and accessible througth the same Id and Name as this node.