Reference

OpcFiniteStateMachineNode Members

Type

OpcFiniteStateMachineNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcFiniteStateMachineNode

10 overloads

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

OpcFiniteStateMachineNode(OpcName)

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

public OpcFiniteStateMachineNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new finite state machine node can be accessed.

OpcFiniteStateMachineNode(OpcName, OpcNodeId)

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

public OpcFiniteStateMachineNode(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 finite state machine node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new finite state machine node can be identified and accessed.

OpcFiniteStateMachineNode(IOpcNode, OpcName)

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

public OpcFiniteStateMachineNode(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 finite state machine node can be accessed.

OpcFiniteStateMachineNode(IOpcNode, OpcName, OpcNodeId)

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

public OpcFiniteStateMachineNode(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 finite state machine node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new finite state machine node can be identified and accessed.

OpcFiniteStateMachineNode(FiniteStateMachineState)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(FiniteStateMachineState content)

Protected Sub New(content As FiniteStateMachineState)

Parameters

Name	Type	Description
content	FiniteStateMachineState	The FiniteStateMachineState to wrap.

Exceptions

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

OpcFiniteStateMachineNode(FiniteStateMachineState, OpcNodeModel)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(
    FiniteStateMachineState content,
    OpcNodeModel model)

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

Parameters

Name	Type	Description
content	FiniteStateMachineState	The FiniteStateMachineState 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).

OpcFiniteStateMachineNode(OpcNodeModel, OpcName)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(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 finite state machine node can be accessed.

OpcFiniteStateMachineNode(OpcNodeModel, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(
    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 finite state machine node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new finite state machine node can be identified and accessed.

OpcFiniteStateMachineNode(OpcNodeModel, IOpcNode, OpcName)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(
    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 finite state machine node can be accessed.

OpcFiniteStateMachineNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcFiniteStateMachineNode(
    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 finite state machine node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new finite state machine node can be identified and accessed.

Properties

AvailableStates

since v2.54

Gets the available states of the OpcFiniteStateMachineNode.

public OpcNodeId[] AvailableStates { get; set; }

Public Property AvailableStates As OpcNodeId()

Property value

OpcNodeId[]

An array of OpcNodeId instances identifying the available states, or a null reference (Nothing in Visual Basic) if the state machine has no AvailableStates variable or the variable has no value.

AvailableStatesNode

since v2.54

Gets the OpcNodeIdArrayVariableNode of the AvailableStates property.

public OpcNodeIdArrayVariableNode AvailableStatesNode { get; }

Public ReadOnly Property AvailableStatesNode As OpcNodeIdArrayVariableNode

Property value

OpcNodeIdArrayVariableNode

An instance of the OpcNodeIdArrayVariableNode class.

AvailableTransitions

since v2.54

Gets the available transitions of the OpcFiniteStateMachineNode.

public OpcNodeId[] AvailableTransitions { get; set; }

Public Property AvailableTransitions As OpcNodeId()

Property value

OpcNodeId[]

An array of OpcNodeId instances identifying the available transitions, or a null reference (Nothing in Visual Basic) if the state machine has no AvailableTransitions variable or the variable has no value.

AvailableTransitionsNode

since v2.54

Gets the OpcNodeIdArrayVariableNode of the AvailableTransitions property.

public OpcNodeIdArrayVariableNode AvailableTransitionsNode { get; }

Public ReadOnly Property AvailableTransitionsNode As OpcNodeIdArrayVariableNode

Property value

OpcNodeIdArrayVariableNode

An instance of the OpcNodeIdArrayVariableNode class.

CurrentState

override

Gets the current state of the OpcFiniteStateMachineNode and provides a human readable name for the current state which may not be suitable for use in application control logic. Applications should use the VariableId property of the CurrentStateNode if they need a unique identifier for the state.

public override OpcText CurrentState { get; set; }

Public Overrides Property CurrentState As OpcText

Property value

OpcText

A human readable name for the current state which may not be suitable for use in application control logic.

Overrides

CurrentState

Implements

CurrentState

CurrentStateNode

Gets the OpcFiniteStateVariableNode of the CurrentState property.

public OpcFiniteStateVariableNode CurrentStateNode { get; }

Public ReadOnly Property CurrentStateNode As OpcFiniteStateVariableNode

Property value

OpcFiniteStateVariableNode

An instance of the OpcFiniteStateVariableNode 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.

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

LastTransition

override

Gets the last transition which occurred in an instance and provides a human readable name for the last transition which may not be suitable for use in application control logic. Applications should use the VariableId property of the LastTransitionNode if they need a unique identifier for the transition.

public override OpcText LastTransition { get; set; }

Public Overrides Property LastTransition As OpcText

Property value

OpcText

A human readable name for the last transition which may not be suitable for use in application control logic.

Overrides

LastTransition

Implements

LastTransition

LastTransitionNode

Gets the OpcFiniteTransitionVariableNode of the LastTransition property.

public OpcFiniteTransitionVariableNode LastTransitionNode { get; }

Public ReadOnly Property LastTransitionNode As OpcFiniteTransitionVariableNode

Property value

OpcFiniteTransitionVariableNode

An instance of the OpcFiniteTransitionVariableNode class, or null if this node is not present.

SupportsCurrentState

virtual · since v2.54

Gets a value indicating whether the current OpcFiniteStateMachineNode does support changes of the CurrentState;

public virtual bool SupportsCurrentState { get; }

Public Overridable ReadOnly Property SupportsCurrentState As Boolean

Property value

Boolean

The value true in case the OpcFiniteStateMachineNode supports state changes; otherwise the value false. The default value is true.

Implements

SupportsCurrentState

Methods

CanChangeStateTo

2 overloads · since v2.54

Overload	Description
CanChangeStateTo(OpcContext, object)since v2.54	Determines whether the CurrentState can be changed to the newState specified using the further specified context.
CanChangeStateTo(OpcContext, object, object)since v2.54	Determines whether the oldState can be changed to the newState specified using the further specified context.

Exceptions (all overloads)

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

CanChangeStateTo(OpcContext, object)

since v2.54

Determines whether the CurrentState can be changed to the newState specified using the further specified context.

public bool CanChangeStateTo(OpcContext context, object newState)

Public Function CanChangeStateTo(
    context As OpcContext,
    newState As Object) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to determine.
newState	Object	The state number or enum of the state to determine.

Returns

Boolean

Implements

CanChangeStateTo

Remarks

In case SupportsCurrentState is equals false, this method does always returns false.

CanChangeStateTo(OpcContext, object, object)

since v2.54

Determines whether the oldState can be changed to the newState specified using the further specified context.

public bool CanChangeStateTo(
    OpcContext context,
    object oldState,
    object newState)

Public Function CanChangeStateTo(
    context As OpcContext,
    oldState As Object,
    newState As Object) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to determine.
oldState	Object	The assumed current state number or enum of the state to determine.
newState	Object	The dedicated new state number or enum of the state to determine.

Returns

Boolean

Implements

CanChangeStateTo

ChangeStateTo

since v2.29

Changes the CurrentState to the newState specified using the further specified context.

public void ChangeStateTo(OpcContext context, object newState)

Public Sub ChangeStateTo(context As OpcContext, newState As Object)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to change.
newState	Object	The state number or enum of the state to change to.

Exceptions

Exception	Condition
ArgumentException	The newState is not a known state.
ArgumentNullException	The context or newState is a null reference (Nothing in Visual Basic).
InvalidOperationException	No transition leads from the current state to the newState.
OpcException	The change operation failed (see exception details for more information).

Implements

ChangeStateTo

Remarks

In case SupportsCurrentState is equals false, this method does not perform any state changes.

CreateSubStatesMachineNode

protected · virtual · since v2.54

When overridden in a derived class, creates the state machine of the sub-states of the state specified.

protected virtual OpcFiniteStateMachineNode CreateSubStatesMachineNode(
    object state)

Protected Overridable Function CreateSubStatesMachineNode(
    state As Object) As OpcFiniteStateMachineNode

Parameters

Name	Type	Description
state	Object	The state number of a state for which the type definition of the state machine declares a state machine of sub-states.

Returns

OpcFiniteStateMachineNode

The state machine of the sub-states of the state. The default implementation returns a null reference (Nothing in Visual Basic).

Remarks

The method is called when the states and transitions of the state machine are determined from its type definition.

GetSubStatesMachineNode

2 overloads · since v2.54

Overload	Description
GetSubStatesMachineNode()since v2.54	Gets the state machine of the sub-states of the current state.
GetSubStatesMachineNode(object)since v2.54	Gets the state machine of the sub-states of the state specified.

GetSubStatesMachineNode()

since v2.54

Gets the state machine of the sub-states of the current state.

public OpcFiniteStateMachineNode GetSubStatesMachineNode()

Public Function GetSubStatesMachineNode() As OpcFiniteStateMachineNode

Returns

OpcFiniteStateMachineNode

The state machine of the sub-states of the current state, or a null reference (Nothing in Visual Basic) if the current state has none.

GetSubStatesMachineNode(object)

since v2.54

Gets the state machine of the sub-states of the state specified.

public OpcFiniteStateMachineNode GetSubStatesMachineNode(object state)

Public Function GetSubStatesMachineNode(
    state As Object) As OpcFiniteStateMachineNode

Parameters

Name	Type	Description
state	Object	The state number or the enumeration member of the state, or a null reference (Nothing in Visual Basic) for the current state.

Returns

OpcFiniteStateMachineNode

The state machine of the sub-states of the state, or a null reference (Nothing in Visual Basic) if the state has none.

IsAccessible

override · since v2.54

Determines whether the node is accessible using the context specified within the view identified by the viewId specified.

public override bool IsAccessible(OpcContext context, OpcNodeId viewId)

Public Overrides Function IsAccessible(
    context As OpcContext,
    viewId As OpcNodeId) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext within that the node is accessed.
viewId	OpcNodeId	The OpcNodeId of the view within that the node is accessed or Null if the node is not accessed within a specific view.

Returns

Boolean

The value false if the node is the state machine of the sub-states of a state (see CreateSubStatesMachineNode); otherwise the value true.

Overrides

IsAccessible

OnBeforeAdded

protected · override · since v2.29

Raises the BeforeAdded event using the event data specified.

protected override void OnBeforeAdded(OpcNodeAddedEventArgs e)

Protected Overrides Sub OnBeforeAdded(e As OpcNodeAddedEventArgs)

Parameters

Name	Type	Description
e	OpcNodeAddedEventArgs	The OpcNodeAddedEventArgs with the event data.

Overrides

OnBeforeAdded