Reference

OpcAcknowledgeableConditionNode Members

Type

OpcAcknowledgeableConditionNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcConditionNode, OpcEventNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcAcknowledgeableConditionNode

10 overloads

Overload	Description
OpcAcknowledgeableConditionNode(OpcName)	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified.
OpcAcknowledgeableConditionNode(OpcName, OpcNodeId)	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified.
OpcAcknowledgeableConditionNode(IOpcNode, OpcName)	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified as a child node of the parent node given.
OpcAcknowledgeableConditionNode(IOpcNode, OpcName, OpcNodeId)	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified as a child node of the parent node given.
OpcAcknowledgeableConditionNode(AcknowledgeableConditionState)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class using the content as the instance to wrap.
OpcAcknowledgeableConditionNode(AcknowledgeableConditionState, OpcNodeModel)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class using the content as the instance to wrap.
OpcAcknowledgeableConditionNode(OpcNodeModel, OpcName)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified.
OpcAcknowledgeableConditionNode(OpcNodeModel, OpcName, OpcNodeId)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified.
OpcAcknowledgeableConditionNode(OpcNodeModel, IOpcNode, OpcName)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name specified as a child node of the parent node given.
OpcAcknowledgeableConditionNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)protected · since v2.50	Initializes a new instance of the OpcAcknowledgeableConditionNode class accessible by the name and id specified as a child node of the parent node given.

OpcAcknowledgeableConditionNode(OpcName)

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

public OpcAcknowledgeableConditionNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new acknowledgeable condition node can be accessed.

OpcAcknowledgeableConditionNode(OpcName, OpcNodeId)

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

public OpcAcknowledgeableConditionNode(OpcName name, OpcNodeId id)

Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
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.

OpcAcknowledgeableConditionNode(IOpcNode, OpcName)

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

public OpcAcknowledgeableConditionNode(IOpcNode parent, OpcName name)

Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

Name	Type	Description
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.

OpcAcknowledgeableConditionNode(IOpcNode, OpcName, OpcNodeId)

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

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

Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
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.

OpcAcknowledgeableConditionNode(AcknowledgeableConditionState)

protected · since v2.50

Initializes a new instance of the OpcAcknowledgeableConditionNode class using the content as the instance to wrap.

protected OpcAcknowledgeableConditionNode(AcknowledgeableConditionState content)

Protected Sub New(content As AcknowledgeableConditionState)

Parameters

Name	Type	Description
content	AcknowledgeableConditionState	The AcknowledgeableConditionState to wrap.

Exceptions

Exception	Condition
ArgumentNullException	The content is a null reference (Nothing in Visual Basic).

OpcAcknowledgeableConditionNode(AcknowledgeableConditionState, OpcNodeModel)

protected · since v2.50

Initializes a new instance of the OpcAcknowledgeableConditionNode class using the content as the instance to wrap.

protected OpcAcknowledgeableConditionNode(
    AcknowledgeableConditionState content,
    OpcNodeModel model)

Protected Sub New(
    content As AcknowledgeableConditionState,
    model As OpcNodeModel)

Parameters

Name	Type	Description
content	AcknowledgeableConditionState	The AcknowledgeableConditionState to wrap.
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.

Exceptions

Exception	Condition
ArgumentNullException	The content is a null reference (Nothing in Visual Basic).

OpcAcknowledgeableConditionNode(OpcNodeModel, OpcName)

protected · since v2.50

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

protected OpcAcknowledgeableConditionNode(OpcNodeModel model, OpcName name)

Protected Sub New(model As OpcNodeModel, name As OpcName)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
name	OpcName	The OpcName through that the new acknowledgeable condition node can be accessed.

OpcAcknowledgeableConditionNode(OpcNodeModel, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcAcknowledgeableConditionNode(
    OpcNodeModel model,
    OpcName name,
    OpcNodeId id)

Protected Sub New(model As OpcNodeModel, name As OpcName, id As OpcNodeId)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
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.

OpcAcknowledgeableConditionNode(OpcNodeModel, IOpcNode, OpcName)

protected · since v2.50

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

protected OpcAcknowledgeableConditionNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name)

Protected Sub New(model As OpcNodeModel, parent As IOpcNode, name As OpcName)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
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.

OpcAcknowledgeableConditionNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcAcknowledgeableConditionNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcNodeId id)

Protected Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId)

Parameters

Name	Type	Description
model	OpcNodeModel	The OpcNodeModel which defines the modelling directives for the new node or a null reference (Nothing in Visual Basic) if there are no directives are to be applied to the node.
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.

Properties

AcknowledgeCallback

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

public OpcAddCommentCallback AcknowledgeCallback { get; set; }

Public Property AcknowledgeCallback As OpcAddCommentCallback

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

AcknowledgeNode

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

public OpcAddCommentMethodNode AcknowledgeNode { get; }

Public ReadOnly Property AcknowledgeNode As OpcAddCommentMethodNode

Property value

OpcAddCommentMethodNode

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

ConfirmCallback

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

public OpcAddCommentCallback ConfirmCallback { get; set; }

Public Property ConfirmCallback As OpcAddCommentCallback

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

ConfirmNode

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

public OpcAddCommentMethodNode ConfirmNode { get; }

Public ReadOnly Property ConfirmNode As OpcAddCommentMethodNode

Property value

OpcAddCommentMethodNode

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

DefaultTypeDefinitionId

protected · override

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

protected override OpcNodeId DefaultTypeDefinitionId { get; }

Protected Overrides ReadOnly Property DefaultTypeDefinitionId As OpcNodeId

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

Overrides

DefaultTypeDefinitionId

IsAcked

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

public bool IsAcked { get; }

Public ReadOnly Property IsAcked As Boolean

Property value

Boolean

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

IsAckedNode

Gets the OpcTwoStateVariableNode of the IsAcked property.

public OpcTwoStateVariableNode IsAckedNode { get; }

Public ReadOnly Property IsAckedNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

IsConfirmed

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

public bool IsConfirmed { get; }

Public ReadOnly Property IsConfirmed As Boolean

Property value

Boolean

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

IsConfirmedNode

Gets the OpcTwoStateVariableNode of the IsConfirmed property.

public OpcTwoStateVariableNode IsConfirmedNode { get; }

Public ReadOnly Property IsConfirmedNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

Methods

Acknowledge

3 overloads

Overload	Description
Acknowledge(OpcContext)	Acknowledges the state reported by an event notification which can be identified by the EventId using the specified context.
Acknowledge(OpcContext, OpcText)	Acknowledges the state reported by an event notification which can be identified by the EventId using the specified context.
Acknowledge(OpcContext, byte[], OpcText)	Acknowledges the state reported by an event notification which can be identified by the eventId using the specified context.

Exceptions (all overloads)

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

Acknowledge(OpcContext)

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

public void Acknowledge(OpcContext context)

Public Sub Acknowledge(context As OpcContext)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.

Exceptions

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

Acknowledge(OpcContext, OpcText)

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

public void Acknowledge(OpcContext context, OpcText comment)

Public Sub Acknowledge(context As OpcContext, comment As OpcText)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.
comment	OpcText	The text to apply on the condition state.

Exceptions

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

Acknowledge(OpcContext, byte[], OpcText)

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

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

Public Sub Acknowledge(
    context As OpcContext,
    eventId As Byte(),
    comment As OpcText)

Parameters

Name	Type	Description
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

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

AcknowledgeCore

protected · virtual

Acknowledges the state of the condition node.

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

Protected Overridable Function AcknowledgeCore(
    context As OpcNodeContext(Of OpcConditionNode),
    eventId As Byte(),
    comment As OpcText) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcConditionNode>	The OpcNodeContext<T> 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.

Confirm

3 overloads

Overload	Description
Confirm(OpcContext)	Confirms the state reported by an event notification which can be identified by the EventId using the specified context.
Confirm(OpcContext, OpcText)	Confirms the state reported by an event notification which can be identified by the EventId using the specified context.
Confirm(OpcContext, byte[], OpcText)	Confirms the state reported by an event notification which can be identified by the eventId using the specified context.

Exceptions (all overloads)

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

Confirm(OpcContext)

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

public void Confirm(OpcContext context)

Public Sub Confirm(context As OpcContext)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.

Exceptions

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

Confirm(OpcContext, OpcText)

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

public void Confirm(OpcContext context, OpcText comment)

Public Sub Confirm(context As OpcContext, comment As OpcText)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.
comment	OpcText	The text to apply on the condition state.

Exceptions

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

Confirm(OpcContext, byte[], OpcText)

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

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

Public Sub Confirm(context As OpcContext, eventId As Byte(), comment As OpcText)

Parameters

Name	Type	Description
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

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

ConfirmCore

protected · virtual

Confirms the state of the condition node.

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

Protected Overridable Function ConfirmCore(
    context As OpcNodeContext(Of OpcConditionNode),
    eventId As Byte(),
    comment As OpcText) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcConditionNode>	The OpcNodeContext<T> 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.

CreateBranchCore

protected · override

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

protected override OpcConditionNode CreateBranchCore()

Protected Overrides Function CreateBranchCore() As OpcConditionNode

Returns

OpcConditionNode

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

Overrides

CreateBranchCore