Reference

OpcFiniteStateMachineNode<T> Members

Type

OpcFiniteStateMachineNode<T>

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcFiniteStateMachineNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcFiniteStateMachineNode

10 overloads

Overload	Description
OpcFiniteStateMachineNode(OpcName)	Initializes a new instance of the OpcFiniteStateMachineNode<T> class accessible by the name specified.
OpcFiniteStateMachineNode(OpcName, OpcNodeId)	Initializes a new instance of the OpcFiniteStateMachineNode<T> class accessible by the name and id specified.
OpcFiniteStateMachineNode(IOpcNode, OpcName)	Initializes a new instance of the OpcFiniteStateMachineNode<T> 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<T> class accessible by the name and id specified as a child node of the parent node given.
OpcFiniteStateMachineNode(FiniteStateMachineState)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> class using the content as the instance to wrap.
OpcFiniteStateMachineNode(FiniteStateMachineState, OpcNodeModel)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> class using the content as the instance to wrap.
OpcFiniteStateMachineNode(OpcNodeModel, OpcName)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> class accessible by the name specified.
OpcFiniteStateMachineNode(OpcNodeModel, OpcName, OpcNodeId)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> class accessible by the name and id specified.
OpcFiniteStateMachineNode(OpcNodeModel, IOpcNode, OpcName)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> class accessible by the name specified as a child node of the parent node given.
OpcFiniteStateMachineNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)protected	Initializes a new instance of the OpcFiniteStateMachineNode<T> 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<T> 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<T> 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<T> 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<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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

Initializes a new instance of the OpcFiniteStateMachineNode<T> 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.

Methods

CanChangeStateTo

2 overloads

Overload	Description
CanChangeStateTo(OpcContext, T)	Determines whether the CurrentState can be changed to the newState specified using the further specified context.
CanChangeStateTo(OpcContext, T, T)	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, T)

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

public bool CanChangeStateTo(OpcContext context, T newState)

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

Parameters

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

Returns

Boolean

Implements

CanChangeStateTo(OpcContext, T)

Remarks

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

CanChangeStateTo(OpcContext, T, T)

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

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

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

Parameters

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

Returns

Boolean

Implements

CanChangeStateTo(OpcContext, T, T)

ChangeStateTo

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

public void ChangeStateTo(OpcContext context, T newState)

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

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to change.
newState	T	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(OpcContext, T)

Remarks

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

CreateSubStatesMachineNode

protected · 2 overloads

Overload	Description
CreateSubStatesMachineNode(object)protected · override	Creates the state machine of the sub-states of the state specified using CreateSubStatesMachineNode.
CreateSubStatesMachineNode(T)protected · virtual	When overridden in a derived class, creates the state machine of the sub-states of the state specified.

CreateSubStatesMachineNode(object)

protected · override

Creates the state machine of the sub-states of the state specified using CreateSubStatesMachineNode.

protected override sealed OpcFiniteStateMachineNode CreateSubStatesMachineNode(
    object state)

Protected NotOverridable Overrides 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 created by CreateSubStatesMachineNode.

Exceptions

Exception	Condition
InvalidCastException	The state number cannot be converted to T.

Overrides

CreateSubStatesMachineNode

Remarks

If T is an enumeration, the state number is passed as the member of the enumeration with that value; otherwise it is converted to T (see ChangeType(object, Type)).

CreateSubStatesMachineNode(T)

protected · virtual

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

protected virtual OpcFiniteStateMachineNode CreateSubStatesMachineNode(T state)

Protected Overridable Function CreateSubStatesMachineNode(
    state As T) As OpcFiniteStateMachineNode

Parameters

Name	Type	Description
state	T	The 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

Gets the state machine of the sub-states of the state specified whose states are identified by values of the type TSubStates.

public OpcFiniteStateMachineNode<TSubStates> GetSubStatesMachineNode<TSubStates>(
    T state)

Public Function GetSubStatesMachineNode(Of TSubStates)(
    state As T) As OpcFiniteStateMachineNode(Of TSubStates)

Type parameters

Name	Description
TSubStates	The type which identifies the sub-states.

Parameters

Name	Type	Description
state	T	The state whose sub-states machine is to be retrieved.

Returns

OpcFiniteStateMachineNode<TSubStates>

The state machine of the sub-states of the state, or a null reference (Nothing in Visual Basic) if the state has none or its states are not identified by TSubStates.