Skip to content

Reference

OpcStateVariableNode Members

Defines a variable node which stores the current state of a state machine as a human readable name.

Reference

OpcStateVariableNode Members ​

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

Inherits members from OpcTextVariableNode, OpcVariableNode, OpcInstanceNode, OpcNode.

Constructors ​

OpcStateVariableNode ​

10 overloads

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

OpcStateVariableNode(OpcName) ​

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

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

Parameters

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

OpcStateVariableNode(OpcName, OpcText) ​

Initializes a new instance of the OpcStateVariableNode class accessible by the name specified with the initial value given by value.

csharp
public OpcStateVariableNode(OpcName name, OpcText value)
vbnet
Public Sub New(name As OpcName, value As OpcText)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new state variable node can be accessed.
valueOpcTextThe initial value of the new state variable node.

OpcStateVariableNode(OpcName, OpcNodeId) ​

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

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

Parameters

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

OpcStateVariableNode(OpcName, OpcNodeId, OpcText) ​

Initializes a new instance of the OpcStateVariableNode class accessible by the name and id specified with the initial value given by value.

csharp
public OpcStateVariableNode(OpcName name, OpcNodeId id, OpcText value)
vbnet
Public Sub New(name As OpcName, id As OpcNodeId, value As OpcText)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new state variable node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new state variable node can be identified and accessed.
valueOpcTextThe initial value of the new state variable node.

OpcStateVariableNode(IOpcNode, OpcName) ​

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

csharp
public OpcStateVariableNode(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 state variable node can be accessed.

OpcStateVariableNode(IOpcNode, OpcName, OpcText) ​

Initializes a new instance of the OpcStateVariableNode class accessible by the name specified with the initial value defined by value as a child node of the parent node given.

csharp
public OpcStateVariableNode(IOpcNode parent, OpcName name, OpcText value)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName, value As OpcText)

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 state variable node can be accessed.
valueOpcTextThe initial value of the new state variable node.

OpcStateVariableNode(IOpcNode, OpcName, OpcNodeId) ​

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

csharp
public OpcStateVariableNode(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 state variable node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new state variable node can be identified and accessed.

OpcStateVariableNode(IOpcNode, OpcName, OpcNodeId, OpcText) ​

Initializes a new instance of the OpcStateVariableNode class accessible by the name and id specified with the initial value defined by value as a child node of the parent node given.

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

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 state variable node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new state variable node can be identified and accessed.
valueOpcTextThe initial value of the new state variable node.

OpcStateVariableNode(StateVariableState) ​

protected · since v2.50

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

csharp
protected OpcStateVariableNode(StateVariableState content)
vbnet
Protected Sub New(content As StateVariableState)

Parameters

NameTypeDescription
contentStateVariableStateThe StateVariableState to wrap.

Exceptions

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

OpcStateVariableNode(StateVariableState, OpcNodeModel) ​

protected · since v2.50

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

csharp
protected OpcStateVariableNode(StateVariableState content, OpcNodeModel model)
vbnet
Protected Sub New(content As StateVariableState, model As OpcNodeModel)

Parameters

NameTypeDescription
contentStateVariableStateThe StateVariableState 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).

Properties ​

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

EffectiveDisplayName ​

Gets or sets a value which contains a human readable name for the current state of the state machine after taking the state of any sub state machines in account.

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

Property value

OpcText

The effective OpcText of the state represented.

Remarks

There is no rule specified for which state or sub-state should be used. It is up to the server and will depend on the semantics of the state machine.

EffectiveDisplayNameNode ​

Gets the OpcTextPropertyNode of the EffectiveDisplayName property.

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

Property value

OpcTextPropertyNode

An instance of the OpcTextPropertyNode class.

Number ​

Gets or sets a numeric identifier which identifies the current state within the state machine.

csharp
[CLSCompliant(false)]
public uint Number { get; set; }
vbnet
<CLSCompliant(False)>
Public Property Number As UInteger

Property value

UInt32

The identifier of the current state within the state machine.

NumberNode ​

Gets the OpcPropertyNode<T> of the Number property.

csharp
public OpcPropertyNode<uint> NumberNode { get; }
vbnet
Public ReadOnly Property NumberNode As OpcPropertyNode(Of UInteger)

Property value

OpcPropertyNode<UInt32>

An instance of the OpcPropertyNode<T> class.

VariableId ​

Gets or sets a value which uniquely identifies the current state within the state machine.

csharp
public object VariableId { get; set; }
vbnet
Public Property VariableId As Object

Property value

Object

A value which uniquely identifies the current state within the state machine.

VariableIdNode ​

Gets the OpcPropertyNode of the VariableId property.

csharp
public OpcPropertyNode VariableIdNode { get; protected set; }
vbnet
Public Property VariableIdNode As OpcPropertyNode

Property value

OpcPropertyNode

An instance of the OpcPropertyNode class.

VariableName ​

Gets or sets the name which uniquely identifies the current state within the state machine.

csharp
public OpcName VariableName { get; set; }
vbnet
Public Property VariableName As OpcName

Property value

OpcName

The OpcName which uniquely identifies the current state within the state machine.

VariableNameNode ​

Gets the OpcNamePropertyNode of the VariableName property.

csharp
public OpcNamePropertyNode VariableNameNode { get; }
vbnet
Public ReadOnly Property VariableNameNode As OpcNamePropertyNode

Property value

OpcNamePropertyNode

An instance of the OpcNamePropertyNode class.