Skip to content

Reference

OpcConditionNode Members

Defines all general characteristics of a condition.

Reference

OpcConditionNode Members ​

Type
OpcConditionNode
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

Inherits members from OpcEventNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors ​

OpcConditionNode ​

10 overloads

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

OpcConditionNode(OpcName) ​

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

csharp
public OpcConditionNode(OpcName name)
vbnet
Public Sub New(name As OpcName)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new condition node can be accessed.

OpcConditionNode(OpcName, OpcNodeId) ​

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

csharp
public OpcConditionNode(OpcName name, OpcNodeId id)
vbnet
Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new condition node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new condition node can be identified and accessed.

OpcConditionNode(IOpcNode, OpcName) ​

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

csharp
public OpcConditionNode(IOpcNode parent, OpcName name)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new condition node can be accessed.

OpcConditionNode(IOpcNode, OpcName, OpcNodeId) ​

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

csharp
public OpcConditionNode(IOpcNode parent, OpcName name, OpcNodeId id)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new condition node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new condition node can be identified and accessed.

OpcConditionNode(ConditionState) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(ConditionState content)
vbnet
Protected Sub New(content As ConditionState)

Parameters

NameTypeDescription
contentConditionStateThe ConditionState to wrap.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe content is a null reference (Nothing in Visual Basic).

OpcConditionNode(ConditionState, OpcNodeModel) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(ConditionState content, OpcNodeModel model)
vbnet
Protected Sub New(content As ConditionState, model As OpcNodeModel)

Parameters

NameTypeDescription
contentConditionStateThe ConditionState to wrap.
modelOpcNodeModelThe 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

ExceptionCondition
ArgumentNullExceptionThe content is a null reference (Nothing in Visual Basic).

OpcConditionNode(OpcNodeModel, OpcName) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(OpcNodeModel model, OpcName name)
vbnet
Protected Sub New(model As OpcNodeModel, name As OpcName)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new condition node can be accessed.

OpcConditionNode(OpcNodeModel, OpcName, OpcNodeId) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(OpcNodeModel model, OpcName name, OpcNodeId id)
vbnet
Protected Sub New(model As OpcNodeModel, name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new condition node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new condition node can be identified and accessed.

OpcConditionNode(OpcNodeModel, IOpcNode, OpcName) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(OpcNodeModel model, IOpcNode parent, OpcName name)
vbnet
Protected Sub New(model As OpcNodeModel, parent As IOpcNode, name As OpcName)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new condition node can be accessed.

OpcConditionNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId) ​

protected · since v2.50

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

csharp
protected OpcConditionNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcNodeId id)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new condition node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new condition node can be identified and accessed.

Properties ​

AddCommentCallback ​

Gets or sets a callback used to add a comment to the condition node.

csharp
public OpcAddCommentCallback AddCommentCallback { get; set; }
vbnet
Public Property AddCommentCallback As OpcAddCommentCallback

Property value

OpcAddCommentCallback

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

AddCommentNode ​

Gets the OpcAddCommentMethodNode used to handle 'AddComment' method calls to add a comment to the condition node.

csharp
public OpcAddCommentMethodNode AddCommentNode { get; }
vbnet
Public ReadOnly Property AddCommentNode As OpcAddCommentMethodNode

Property value

OpcAddCommentMethodNode

An instance of the OpcAddCommentMethodNode class. Which uses an OpcConditionNode defined callback to add a comment to the condition node.

AutoReportChanges ​

Gets or sets a value indicating whether the OpcConditionNode will automatically report an event when a change method call completes.

csharp
public bool AutoReportChanges { get; set; }
vbnet
Public Property AutoReportChanges As Boolean

Property value

Boolean

The value true, if the event automatically reports any change performed using a method to modify the node; otherwise the value false (the default value is false).

BranchId ​

Gets or sets an identifier which identifies the branch to that the event does belong.

csharp
public OpcNodeId BranchId { get; set; }
vbnet
Public Property BranchId As OpcNodeId

Property value

OpcNodeId

A null reference (Nothing in Visual Basic) if the event relates to the current state of the condition. Otherwise it identifies a previous state of this condition that still needs attention by an operator. If the current condition branch is transformed into a previous condition branch then the server needs to assign a non-null branch identifier. An initial event for the branch will generated with the values of the condition branch and the new branch identifier. The condition branch can be updated many times before it is no longer needed. When the condition branch no longer requires operator input the final event will have IsRetained set to false. The IsRetained property on the current event is true, as long as any condition branches require operator input.

BranchIdNode ​

Gets the OpcNodeIdPropertyNode of the BranchId property.

csharp
public OpcNodeIdPropertyNode BranchIdNode { get; }
vbnet
Public ReadOnly Property BranchIdNode As OpcNodeIdPropertyNode

Property value

OpcNodeIdPropertyNode

An instance of the OpcNodeIdPropertyNode class.

ClientUserId ​

Gets or sets an identifier that is related to the Comment and contains the identity of the user who inserted the most recent Comment.

csharp
public string ClientUserId { get; set; }
vbnet
Public Property ClientUserId As String

Property value

String

A value which identifies the user who inserted the most recent Comment.

ClientUserIdNode ​

Gets the OpcPropertyNode<T> of the ClientUserId property.

csharp
public OpcPropertyNode<string> ClientUserIdNode { get; }
vbnet
Public ReadOnly Property ClientUserIdNode As OpcPropertyNode(Of String)

Property value

OpcPropertyNode<String>

An instance of the OpcPropertyNode<T> class.

Comment ​

Gets or sets the last comment provided for a certain state (condition branch).

csharp
public OpcText Comment { get; set; }
vbnet
Public Property Comment As OpcText

Property value

OpcText

The last comment provided for a certian state (condition branch).

Remarks

It may have been provided by an 'AddComment' method, some other method or in some other manner. The initial value of this variable is a null reference (Nothing in Visual Basic), unless it is provided in some other manner. If a method provides as an option the ability to set a comment, then the value of this variable is reset to a null reference (Nothing in Visual Basic) if an optional comment is not provided.

CommentNode ​

Gets the OpcTextConditionVariableNode of the Comment property.

csharp
public OpcTextConditionVariableNode CommentNode { get; }
vbnet
Public ReadOnly Property CommentNode As OpcTextConditionVariableNode

Property value

OpcTextConditionVariableNode

An instance of the OpcTextConditionVariableNode class.

ConditionClassId ​

Gets or sets a value which specifies in which domain this condition is used. It is the OpcNodeId of the corresponding condition class type.

csharp
public OpcNodeId ConditionClassId { get; set; }
vbnet
Public Property ConditionClassId As OpcNodeId

Property value

OpcNodeId

An OpcNodeId which identifies the corresponding condition class type.

ConditionClassIdNode ​

Gets the OpcNodeIdPropertyNode of the ConditionClassId property.

csharp
public OpcNodeIdPropertyNode ConditionClassIdNode { get; }
vbnet
Public ReadOnly Property ConditionClassIdNode As OpcNodeIdPropertyNode

Property value

OpcNodeIdPropertyNode

An instance of the OpcNodeIdPropertyNode class.

ConditionClassName ​

Gets or sets a value that matches the display name of the condition class type.

csharp
public OpcText ConditionClassName { get; set; }
vbnet
Public Property ConditionClassName As OpcText

Property value

OpcText

The display name of the condition class referenced by the ConditionClassId.

ConditionClassNameNode ​

Gets the OpcTextPropertyNode of the ConditionClassName property.

csharp
public OpcTextPropertyNode ConditionClassNameNode { get; }
vbnet
Public ReadOnly Property ConditionClassNameNode As OpcTextPropertyNode

Property value

OpcTextPropertyNode

An instance of the OpcTextPropertyNode class.

ConditionName ​

Gets or sets a value which identifies the condition instance that the event originated from.

csharp
public string ConditionName { get; set; }
vbnet
Public Property ConditionName As String

Property value

String

A value which identifies the condition instance that the event originated from.

Remarks

It can be used together with the SourceName in a user display to distinguish between different condition instances. If a condition source has only one instance of a condition type, and the server has no instance name, the server shall supply the condition type browse name.

ConditionNameNode ​

Gets the OpcPropertyNode<T> of the ConditionName property.

csharp
public OpcPropertyNode<string> ConditionNameNode { get; }
vbnet
Public ReadOnly Property ConditionNameNode As OpcPropertyNode(Of String)

Property value

OpcPropertyNode<String>

An instance of the OpcPropertyNode<T> class.

DefaultTypeDefinitionId ​

protected · override

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

csharp
protected override OpcNodeId DefaultTypeDefinitionId { get; }
vbnet
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

DisableCallback ​

Gets or sets a callback used to disable the condition node.

csharp
public OpcNodeFunc<OpcConditionNode> DisableCallback { get; set; }
vbnet
Public Property DisableCallback As OpcNodeFunc(Of OpcConditionNode)

Property value

OpcNodeFunc<OpcConditionNode>

A OpcNodeFunc<T> used to disable the condition node. The value can also be a null reference (Nothing in Visual Basic).

DisableNode ​

Gets the OpcActionMethodNode used to handle 'Disable' method calls to disable the condition.

csharp
public OpcActionMethodNode DisableNode { get; }
vbnet
Public ReadOnly Property DisableNode As OpcActionMethodNode

Property value

OpcActionMethodNode

An instance of the OpcActionMethodNode class. Which uses an OpcConditionNode defined callback to disable the condition.

EnableCallback ​

Gets or sets a callback used to enable the condition node.

csharp
public OpcNodeFunc<OpcConditionNode> EnableCallback { get; set; }
vbnet
Public Property EnableCallback As OpcNodeFunc(Of OpcConditionNode)

Property value

OpcNodeFunc<OpcConditionNode>

A OpcNodeFunc<T> used to enable the condition node. The value can also be a null reference (Nothing in Visual Basic).

EnableNode ​

Gets the OpcActionMethodNode used to handle 'Enable' method calls to enable the condition.

csharp
public OpcActionMethodNode EnableNode { get; }
vbnet
Public ReadOnly Property EnableNode As OpcActionMethodNode

Property value

OpcActionMethodNode

An instance of the OpcActionMethodNode class. Which uses an OpcConditionNode defined callback to enable the condition.

IsEnabled ​

Gets a value indicating whether the condition is enabled.

csharp
public bool IsEnabled { get; }
vbnet
Public ReadOnly Property IsEnabled As Boolean

Property value

Boolean

A value indicating whether the condition is enabled.

Remarks

A condition's IsEnabled state effects the generation of event notifications and as such results in the following specific behaviour:

  • When the condition enters the disabled state, the IsRetained property of this condition is set to the false enabled state by the server so indicate to the client that the condition is currently not of interest to clients.
  • When the condition enters the enabled state, the condition is to be evaluated and all of its properties updated to reflect the current values. If this evaluation causes the IsRetained property to transition to to true for any condition branch, then an event notification is generated for that condition branch.
  • The server may choose to continue to test for a condition while it is disabled. However, no event notifications will be generated while the condition is disabled.
  • For any condition that exists in the address space the attributes and the following variables will continue to have valid values even in the disabled state; EventId, EventTypeId, SourceNodeId, SourceName, Time, and IsEnabled. Other properties may no longer provide current valid values. All variables that are no longer provided will return a status of BadConditionDisabled. The event that reports the disabled state will report the properties as a null reference (Nothing in Visual Basic) or with a status of BadConditionDisabled.

IsEnabledNode ​

Gets the OpcTwoStateVariableNode of the IsEnabled property.

csharp
public OpcTwoStateVariableNode IsEnabledNode { get; }
vbnet
Public ReadOnly Property IsEnabledNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

IsRetained ​

Gets or sets a value indicating whether the condition is in a state that is interesting for a client wishing to synchronize its state with the server's state.

csharp
public bool IsRetained { get; set; }
vbnet
Public Property IsRetained As Boolean

Property value

Boolean

The value true if the condition (or condition branch) is being in a state that is interesting for a client wishing to synchronize its state with the server's state. The logic to determine how this flag is set is server specific. Typically all active alarms would have the IsRetained flag set; however, it is also possible for inactive alarms to have their IsRetained flag set to true. In general events are only generated for conditions that have their IsRetained property set to the value true.

IsRetainedNode ​

Gets the OpcPropertyNode<T> of the IsRetained property.

csharp
public OpcPropertyNode<bool> IsRetainedNode { get; }
vbnet
Public ReadOnly Property IsRetainedNode As OpcPropertyNode(Of Boolean)

Property value

OpcPropertyNode<Boolean>

An instance of the OpcPropertyNode<T> class.

IsRetainedPolicy ​

since v2.55

Gets or sets the evaluation policy that controls the lifecycle of the IsRetained property for this OpcConditionNode.

csharp
public OpcConditionRetainPolicy IsRetainedPolicy { get; set; }
vbnet
Public Property IsRetainedPolicy As OpcConditionRetainPolicy

Property value

OpcConditionRetainPolicy

One of the members defined by the OpcConditionRetainPolicy enumeration determining when the condition is automatically cleared from active client lists.

Remarks

SDK Architecture Note: The IsRetained property indictates whether a condition appears in a client's active alarm view or is returned during a ConditionRefresh operation. By changing this policy, you control the underlying state machine that automatically recalculates the IsRetained> value when states like ActiveState, AckedState, or LatchedState change.

Default Behavior:

Compliance Rule: Regardless of the selected policy, if IsEnabled transitions to Disabled (False), the SDK will override the policy and strictly force Retain = false to comply with the OPC UA Part 9 specification.

LastSeverity ​

Gets or sets a value which provides the previous severity of the condition branch.

csharp
public OpcEventSeverity LastSeverity { get; set; }
vbnet
Public Property LastSeverity As OpcEventSeverity

Property value

OpcEventSeverity

The initial value of this property is Undefined; it will provide a more meaningful value only after a severity change. The new severity is supplied via the Severity property.

LastSeverityNode ​

Gets the OpcConditionVariableNode<T> of the LastSeverity property.

csharp
public OpcConditionVariableNode<ushort> LastSeverityNode { get; }
vbnet
Public ReadOnly Property LastSeverityNode As OpcConditionVariableNode(Of UShort)

Property value

OpcConditionVariableNode<UInt16>

An instance of the OpcConditionVariableNode<T> class.

Quality ​

Gets or sets a value which reveals the status of process values or other resources that this condition is based upon.

csharp
public OpcStatus Quality { get; set; }
vbnet
Public Property Quality As OpcStatus

Property value

OpcStatus

The quality of data that this condition is based upon. If, for example, a process value is 'Uncertain', the associated 'LevelAlarm' condition is also questionable. Values for the Quality can be any of the OpcStatusCode enumeration members as well as Good, Uncertain and Bad. These status codes are similar to but slightly more generic than the description of data quality in the various field bus specifications. It is the responsibility of the server to map internal status information to these codes. A server which supports no quality information returns Good. This quality can also reflect the communication status associated with the system that this value or resource is based on and from which this alarm was received. For communication errors to the underlying system, especially those that result in some unavailable event fields, the quality is BadNoCommunication.

QualityNode ​

Gets the OpcStatusConditionVariableNode of the Quality property.

csharp
public OpcStatusConditionVariableNode QualityNode { get; }
vbnet
Public ReadOnly Property QualityNode As OpcStatusConditionVariableNode

Property value

OpcStatusConditionVariableNode

An instance of the OpcStatusConditionVariableNode class.

Methods ​

AddComment ​

2 overloads

OverloadDescription
AddComment(OpcContext, OpcText)Applies a comment to the state reported by an event notification which can be identified by the EventId using the specified context.
AddComment(OpcContext, byte[], OpcText)Applies a comment to the state reported by an event notification which can be identified by the eventId using the specified context.

Exceptions (all overloads)

ExceptionCondition
OpcExceptionThe call failed (see exception details for more information).

AddComment(OpcContext, OpcText) ​

Applies a comment to the state reported by an event notification which can be identified by the EventId using the specified context.

csharp
public void AddComment(OpcContext context, OpcText comment)
vbnet
Public Sub AddComment(context As OpcContext, comment As OpcText)

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.
commentOpcTextThe text to apply on the condition state.

Exceptions

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

AddComment(OpcContext, byte[], OpcText) ​

Applies a comment to the state reported by an event notification which can be identified by the eventId using the specified context.

csharp
public void AddComment(OpcContext context, byte[] eventId, OpcText comment)
vbnet
Public Sub AddComment(
    context As OpcContext,
    eventId As Byte(),
    comment As OpcText)

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.
eventIdByte[]The identifier which identifies the particular event notification its reported state for the condition node is to be commented.
commentOpcTextThe text to apply on the condition state.

Exceptions

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

AddCommentCore ​

protected · virtual

Applies the comment to the state of the condition node.

csharp
protected virtual OpcStatusCode AddCommentCore(
    OpcNodeContext<OpcConditionNode> context,
    byte[] eventId,
    OpcText comment)
vbnet
Protected Overridable Function AddCommentCore(
    context As OpcNodeContext(Of OpcConditionNode),
    eventId As Byte(),
    comment As OpcText) As OpcStatusCode

Parameters

NameTypeDescription
contextOpcNodeContext<OpcConditionNode>The OpcNodeContext<T> to use to apply the comment.
eventIdByte[]The identifier identifying a particular event notification where a state was reported for a condition.
commentOpcTextA localized text to be applied to the condition.

Returns

OpcStatusCode

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

CreateBranch ​

2 overloads

OverloadDescription
CreateBranch(OpcContext)Creates a new instance of the OpcConditionNode class which can be used to maintain branched event information.
CreateBranch(OpcContext, OpcNodeId)Creates a new instance of the OpcConditionNode class using the branchId specified to maintain branched event information.

CreateBranch(OpcContext) ​

Creates a new instance of the OpcConditionNode class which can be used to maintain branched event information.

csharp
public OpcConditionNode CreateBranch(OpcContext context)
vbnet
Public Function CreateBranch(context As OpcContext) As OpcConditionNode

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.

Returns

OpcConditionNode

A new instance of the OpcConditionNode class there its BranchId is set to a Guid created using NewGuid().

CreateBranch(OpcContext, OpcNodeId) ​

Creates a new instance of the OpcConditionNode class using the branchId specified to maintain branched event information.

csharp
public OpcConditionNode CreateBranch(OpcContext context, OpcNodeId branchId)
vbnet
Public Function CreateBranch(
    context As OpcContext,
    branchId As OpcNodeId) As OpcConditionNode

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.
branchIdOpcNodeIdThe OpcNodeId to use to define the custom branch identifier to use for the BranchId of the new OpcConditionNode instance to create.

Returns

OpcConditionNode

A new instance of the OpcConditionNode class there its BranchId is set to the branchId specified.

CreateBranchCore ​

protected · virtual

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

csharp
protected virtual OpcConditionNode CreateBranchCore()
vbnet
Protected Overridable Function CreateBranchCore() As OpcConditionNode

Returns

OpcConditionNode

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

Disable ​

Changes the condition state to 'Disabled' using the specified context.

csharp
public void Disable(OpcContext context)
vbnet
Public Sub Disable(context As OpcContext)

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe context is a null reference (Nothing in Visual Basic).
OpcExceptionThe call failed (see exception details for more information).

DisableCore ​

protected · virtual

Disables the condition node.

csharp
protected virtual OpcStatusCode DisableCore(
    OpcNodeContext<OpcConditionNode> context)
vbnet
Protected Overridable Function DisableCore(
    context As OpcNodeContext(Of OpcConditionNode)) As OpcStatusCode

Parameters

NameTypeDescription
contextOpcNodeContext<OpcConditionNode>The OpcNodeContext<T> to use to disable the condition node.

Returns

OpcStatusCode

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

Enable ​

Changes the condition state to 'Enabled' using the specified context.

csharp
public void Enable(OpcContext context)
vbnet
Public Sub Enable(context As OpcContext)

Parameters

NameTypeDescription
contextOpcContextThe OpcContext to use.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe context is a null reference (Nothing in Visual Basic).
OpcExceptionThe call failed (see exception details for more information).

EnableCore ​

protected · virtual

Enables the condition node.

csharp
protected virtual OpcStatusCode EnableCore(
    OpcNodeContext<OpcConditionNode> context)
vbnet
Protected Overridable Function EnableCore(
    context As OpcNodeContext(Of OpcConditionNode)) As OpcStatusCode

Parameters

NameTypeDescription
contextOpcNodeContext<OpcConditionNode>The OpcNodeContext<T> to use to enable the condition node.

Returns

OpcStatusCode

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

InitializeDefaults ​

protected · override

Initializes the default values used by the OpcConditionNode.

csharp
protected override void InitializeDefaults()
vbnet
Protected Overrides Sub InitializeDefaults()

Overrides

InitializeDefaults

Remarks

This method is used to ensure the availability of appropriate node specific default values. For more information like when this method is to be overwritten see InitializeDefaults.