# OpcShelvedStateMachineNode Class

> Reference: Defines a specialization of the OpcFiniteStateMachineNode which implements a sub-state machine that represents an advanced alarm filtering model.

<dl class="api-definition">
<dt>Namespace</dt>
<dd><a href="../namespaces/opc.uafx">Opc.UaFx</a></dd>
<dt>Assembly</dt>
<dd>Opc.UaFx.Advanced.dll</dd>
<dt>Package</dt>
<dd>Opc.UaFx.Advanced v2.59.0</dd>
<dt>Members</dt>
<dd><a href="./members">OpcShelvedStateMachineNode Members</a></dd>
</dl>

Defines a specialization of the [OpcFiniteStateMachineNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcfinitestatemachinenode/) which implements a sub-state machine that represents an advanced alarm filtering model.

## Syntax

<div class="api-signature" data-lang="csharp">

```csharp
public class OpcShelvedStateMachineNode : OpcFiniteStateMachineNode
```

</div>

<div class="api-signature" data-lang="vbnet">

```vbnet
Public Class OpcShelvedStateMachineNode
    Inherits OpcFiniteStateMachineNode
```

</div>

## Inheritance

[Object](https://learn.microsoft.com/dotnet/api/system.object) → [OpcNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcnode/) → [OpcInstanceNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcinstancenode/) → [OpcObjectNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcobjectnode/) → [OpcStateMachineNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcstatemachinenode/) → [OpcFiniteStateMachineNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcfinitestatemachinenode/) → **OpcShelvedStateMachineNode**

## Implements

<ul class="api-implements">
<li><a href="../opc.uafx.iopcnode/">IOpcNode</a></li>
<li><a href="../opc.uafx.iopcnodeinfo/">IOpcNodeInfo</a></li>
<li><a href="../opc.uafx.iopcstatemachine/">IOpcStateMachine</a></li>
</ul>

## Remarks

The state model supports two types of Shelving: OneShotShelving and TimedShelving. This includes the allowed transitions between the various sub-states. Shelving is an operator initiated activity.

In OneShotShelving, a user requests that an alarm be shelved for its current active state. This type of shelving is typically used when an alarm is continually occurring on a boundary (i.e. a condition is jumping between high alarm and high high alarm, always in the active state). The one shot shelving will automatically clear when an alarm returns to an inactive state. Another use for this type of shelving is for a plant area that is shutdown i.e. a long running alarm such as a low level alarm for a tank that is not in use. When the tank starts operation again the shelving state will automatically clear.

In TimedShelving, a user specifies that an alarm be shelved for a fixed time period. This type of shelving is quite often used to block nuisance alarms. For example, an alarm that occurs more than 10 times in a minute may get shelved for a few minutes.

In all states, the [Unshelve](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelve) can be called to cause a transition to the unshelve state; this includes un-shelving an alarm that is in the timed shelve state before the time has expired and the one shot shelve state without a transition to an inactive state.

The 'Time Expired' transition is simply a system generated transition that occurs when the time value defined as part of the 'Timed Shelved Call' has expired. The 'Any Transition Occurs' transition is also a system generated transition; this transition is generated when the condition goes to an inactive state.

## Constructors

| Name | Description |
|---|---|
| [OpcShelvedStateMachineNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#opcshelvedstatemachinenode)<span class="api-meta">6 overloads</span> | Initializes a new instance of the OpcShelvedStateMachineNode class accessible by the `name` specified. |

## Properties

| Name | Description |
|---|---|
| [DefaultTypeDefinitionId](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#defaulttypedefinitionid)<span class="api-meta">protected · override</span> | Gets the default identifier which identifies the node that defines the underlying node type from that this [OpcInstanceNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcinstancenode/) has been created. |
| [OneShotShelveCallback](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#oneshotshelvecallback) | Gets or sets a callback used to shelve the condition node once. |
| [OneShotShelveNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#oneshotshelvenode) | Gets the [OpcActionMethodNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcactionmethodnode/) used to handle 'OneShotShelve' method calls to shelve a condition node once. |
| [TimedShelveCallback](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#timedshelvecallback) | Gets or sets a callback used to shelve the condition node for a specific amount of time. |
| [TimedShelveNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#timedshelvenode) | Gets the [OpcTimedShelveMethodNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opctimedshelvemethodnode/) used to handle 'TimedShelve' method calls to shelve a condition node for a specific amount of time. |
| [UnshelveCallback](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvecallback) | Gets or sets a callback used to unshelve the condition node. |
| [UnshelveNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvenode) | Gets the [OpcActionMethodNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcactionmethodnode/) used to handle 'Unshelve' method calls to unshelve a condition node. |
| [UnshelveTime](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvetime) | Gets the remaining time in milliseconds until the alarm automatically transitions into the un-shelved state. |
| [UnshelveTimeNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvetimenode) | Gets the [OpcPropertyNode&lt;T&gt;](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcpropertynode-1/) of the [UnshelveTime](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvetime) property. |

## Methods

| Name | Description |
|---|---|
| [OneShotShelve](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#oneshotshelve) | Shelves a condition node once using the `context` specified. |
| [OneShotShelveCore](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#oneshotshelvecore)<span class="api-meta">protected · virtual</span> | Shelves a condition node once using the `context` specified. |
| [TimedShelve](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#timedshelve) | Shelves a condition node for specific amount of time using the `context` and `duration` specified. |
| [TimedShelveCore](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#timedshelvecore)<span class="api-meta">protected · virtual</span> | Shelves a condition node using the `context` and `duration` information specified. |
| [Unshelve](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelve) | Unshelves a condition node using the `context` specified. |
| [UnshelveCore](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcshelvedstatemachinenode/members#unshelvecore)<span class="api-meta">protected · virtual</span> | Unshelves a condition node using the `context` specified. |

Inherits members from [OpcFiniteStateMachineNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcfinitestatemachinenode/members), [OpcObjectNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcobjectnode/members), [OpcInstanceNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcinstancenode/members), [OpcNode](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.opcnode/members).

## Extension methods

| Name | Description |
|---|---|
| [OpcStateMachineNodeExtension.ChangeState](https://www.traeger.de/en/docs/development/opcua/api/v2.59/opc.uafx.server.opcstatemachinenodeextension/members#changestate) | Changes the current state of the `stateMachineNode` specified using the further specified `context`. |

## Applies to

| Package | Versions |
|---|---|
| Opc.UaFx.Advanced | v2.5–v2.59 |