Reference

OpcShelvedStateMachineNode Members

Type

OpcShelvedStateMachineNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcFiniteStateMachineNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcShelvedStateMachineNode

6 overloads

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

OpcShelvedStateMachineNode(OpcName)

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

public OpcShelvedStateMachineNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

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

OpcShelvedStateMachineNode(OpcName, OpcNodeId)

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

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

OpcShelvedStateMachineNode(IOpcNode, OpcName)

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

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

OpcShelvedStateMachineNode(IOpcNode, OpcName, OpcNodeId)

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

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

OpcShelvedStateMachineNode(ShelvedStateMachineState)

protected · since v2.50

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

protected OpcShelvedStateMachineNode(ShelvedStateMachineState content)

Protected Sub New(content As ShelvedStateMachineState)

Parameters

Name	Type	Description
content	ShelvedStateMachineState	The ShelvedStateMachineState to wrap.

Exceptions

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

OpcShelvedStateMachineNode(ShelvedStateMachineState, OpcNodeModel)

protected · since v2.50

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

protected OpcShelvedStateMachineNode(
    ShelvedStateMachineState content,
    OpcNodeModel model)

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

Parameters

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

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.

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

OneShotShelveCallback

Gets or sets a callback used to shelve the condition node once.

public OpcNodeFunc<OpcShelvedStateMachineNode> OneShotShelveCallback { get; set; }

Public Property OneShotShelveCallback As OpcNodeFunc(Of OpcShelvedStateMachineNode)

Property value

OpcNodeFunc<OpcShelvedStateMachineNode>

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

OneShotShelveNode

Gets the OpcActionMethodNode used to handle 'OneShotShelve' method calls to shelve a condition node once.

public OpcActionMethodNode OneShotShelveNode { get; }

Public ReadOnly Property OneShotShelveNode As OpcActionMethodNode

Property value

OpcActionMethodNode

An instance of the OpcActionMethodNode class. Which uses an OpcShelvedStateMachineNode defined callback to shelve a condition node.

TimedShelveCallback

Gets or sets a callback used to shelve the condition node for a specific amount of time.

public OpcNodeFunc<OpcShelvedStateMachineNode, TimeSpan> TimedShelveCallback { get; set; }

Public Property TimedShelveCallback As OpcNodeFunc(Of OpcShelvedStateMachineNode, TimeSpan)

Property value

OpcNodeFunc<OpcShelvedStateMachineNode, TimeSpan>

A OpcNodeFunc<T, T1> used to shelve the condition node for a specific amount of time. The value can also be a null reference (Nothing in Visual Basic).

TimedShelveNode

Gets the OpcTimedShelveMethodNode used to handle 'TimedShelve' method calls to shelve a condition node for a specific amount of time.

public OpcTimedShelveMethodNode TimedShelveNode { get; }

Public ReadOnly Property TimedShelveNode As OpcTimedShelveMethodNode

Property value

OpcTimedShelveMethodNode

An instance of the OpcTimedShelveMethodNode class. Which uses an OpcShelvedStateMachineNode defined callback to shelve a condition node for a specific amount of time.

UnshelveCallback

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

public OpcNodeFunc<OpcShelvedStateMachineNode> UnshelveCallback { get; set; }

Public Property UnshelveCallback As OpcNodeFunc(Of OpcShelvedStateMachineNode)

Property value

OpcNodeFunc<OpcShelvedStateMachineNode>

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

UnshelveNode

Gets the OpcActionMethodNode used to handle 'Unshelve' method calls to unshelve a condition node.

public OpcActionMethodNode UnshelveNode { get; }

Public ReadOnly Property UnshelveNode As OpcActionMethodNode

Property value

OpcActionMethodNode

An instance of the OpcActionMethodNode class. Which uses an OpcShelvedStateMachineNode defined callback to unshelve a condition node.

UnshelveTime

Gets the remaining time in milliseconds until the alarm automatically transitions into the un-shelved state.

public double UnshelveTime { get; }

Public ReadOnly Property UnshelveTime As Double

Property value

Double

For the timed shelved state this time is initialised with the shelving time argument of the TimedShelve method call. For the one shot shelved state the UnshelveTime will be a constant set to the maximum duration except if a 'MaxTimeShelved' property is provided.

UnshelveTimeNode

Gets the OpcPropertyNode<T> of the UnshelveTime property.

public OpcPropertyNode<double> UnshelveTimeNode { get; }

Public ReadOnly Property UnshelveTimeNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

Methods

OneShotShelve

Shelves a condition node once using the context specified.

public void OneShotShelve(OpcContext context)

Public Sub OneShotShelve(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).
OpcException	The call failed (see exception details for more information).

OneShotShelveCore

protected · virtual

Shelves a condition node once using the context specified.

protected virtual OpcStatusCode OneShotShelveCore(
    OpcNodeContext<OpcShelvedStateMachineNode> context)

Protected Overridable Function OneShotShelveCore(
    context As OpcNodeContext(Of OpcShelvedStateMachineNode)) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcShelvedStateMachineNode>	The OpcNodeContext<T> to use to shelve a condition node once.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the shelving using the OneShotShelveCallback or BadNotSupported if there is no custom callback routine defined.

TimedShelve

Shelves a condition node for specific amount of time using the context and duration specified.

public void TimedShelve(OpcContext context, TimeSpan duration)

Public Sub TimedShelve(context As OpcContext, duration As TimeSpan)

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use.
duration	TimeSpan	The amount of time a condition node is to be shelved.

Exceptions

Exception	Condition
ArgumentNullException	The context is a null reference (Nothing in Visual Basic).
OpcException	The call failed (see exception details for more information).

TimedShelveCore

protected · virtual

Shelves a condition node using the context and duration information specified.

protected virtual OpcStatusCode TimedShelveCore(
    OpcNodeContext<OpcShelvedStateMachineNode> context,
    TimeSpan duration)

Protected Overridable Function TimedShelveCore(
    context As OpcNodeContext(Of OpcShelvedStateMachineNode),
    duration As TimeSpan) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcShelvedStateMachineNode>	The OpcNodeContext<T> to use to shelve the condition node for specific amount of time.
duration	TimeSpan	The amount of time a condition node is to be shelved.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the shelving using the TimedShelveCallback or BadNotSupported if there is no custom callback routine defined.

Unshelve

Unshelves a condition node using the context specified.

public void Unshelve(OpcContext context)

Public Sub Unshelve(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).
OpcException	The call failed (see exception details for more information).

UnshelveCore

protected · virtual

Unshelves a condition node using the context specified.

protected virtual OpcStatusCode UnshelveCore(
    OpcNodeContext<OpcShelvedStateMachineNode> context)

Protected Overridable Function UnshelveCore(
    context As OpcNodeContext(Of OpcShelvedStateMachineNode)) As OpcStatusCode

Parameters

Name	Type	Description
context	OpcNodeContext<OpcShelvedStateMachineNode>	The OpcNodeContext<T> to use to unshelve a condition node.

Returns

OpcStatusCode

The OpcStatusCode specifying the outcome of the unshelving using the UnshelveCallback or BadNotSupported if there is no custom callback routine defined.