Reference

OpcAlarmConditionNode Members

Type

OpcAlarmConditionNode

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Inherits members from OpcAcknowledgeableConditionNode, OpcConditionNode, OpcEventNode, OpcObjectNode, OpcInstanceNode, OpcNode.

Constructors

OpcAlarmConditionNode

10 overloads

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

OpcAlarmConditionNode(OpcName)

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

public OpcAlarmConditionNode(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName through that the new alarm condition node can be accessed.

OpcAlarmConditionNode(OpcName, OpcNodeId)

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

public OpcAlarmConditionNode(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 alarm condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new alarm condition node can be identified and accessed.

OpcAlarmConditionNode(IOpcNode, OpcName)

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

public OpcAlarmConditionNode(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 alarm condition node can be accessed.

OpcAlarmConditionNode(IOpcNode, OpcName, OpcNodeId)

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

public OpcAlarmConditionNode(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 alarm condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new alarm condition node can be identified and accessed.

OpcAlarmConditionNode(AlarmConditionState)

protected · since v2.50

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

protected OpcAlarmConditionNode(AlarmConditionState content)

Protected Sub New(content As AlarmConditionState)

Parameters

Name	Type	Description
content	AlarmConditionState	The AlarmConditionState to wrap.

Exceptions

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

OpcAlarmConditionNode(AlarmConditionState, OpcNodeModel)

protected · since v2.50

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

protected OpcAlarmConditionNode(AlarmConditionState content, OpcNodeModel model)

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

Parameters

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

OpcAlarmConditionNode(OpcNodeModel, OpcName)

protected · since v2.50

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

protected OpcAlarmConditionNode(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 alarm condition node can be accessed.

OpcAlarmConditionNode(OpcNodeModel, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcAlarmConditionNode(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 alarm condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new alarm condition node can be identified and accessed.

OpcAlarmConditionNode(OpcNodeModel, IOpcNode, OpcName)

protected · since v2.50

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

protected OpcAlarmConditionNode(
    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 alarm condition node can be accessed.

OpcAlarmConditionNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)

protected · since v2.50

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

protected OpcAlarmConditionNode(
    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 alarm condition node can be accessed.
id	OpcNodeId	The OpcNodeId through that the new alarm condition node can be identified and accessed.

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

InputNodeId

Gets or sets an identifier which represents the node identifier of the variable the value of which is used as primary input in the calculation of the alarm state.

public OpcNodeId InputNodeId { get; set; }

Public Property InputNodeId As OpcNodeId

Property value

OpcNodeId

If this variable is not in the address space, Null is provided. In some systems, an alarm may be calculated based on multiple variable values; it is up to the system to determine which variable's node identifier is used.

InputNodeIdNode

Gets the OpcNodeIdPropertyNode of the InputNodeId property.

public OpcNodeIdPropertyNode InputNodeIdNode { get; }

Public ReadOnly Property InputNodeIdNode As OpcNodeIdPropertyNode

Property value

OpcNodeIdPropertyNode

An instance of the OpcNodeIdPropertyNode class.

IsActive

Gets a value indicating whether the alarm situation represented currently exists.

public bool IsActive { get; }

Public ReadOnly Property IsActive As Boolean

Property value

Boolean

A value indicating whether the alarm situation represented currently exists.

IsActiveNode

Gets the OpcTwoStateVariableNode of the IsActive property.

public OpcTwoStateVariableNode IsActiveNode { get; }

Public ReadOnly Property IsActiveNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

IsSuppressed

Gets a value indicating whether the alarm is suppressed due to system specific reasons.

public bool IsSuppressed { get; }

Public ReadOnly Property IsSuppressed As Boolean

Property value

Boolean

The value is used internally by the server to automatically suppress alarms due to system specific reasons. For example a system may be configured to suppress alarms that are associated with machinery that is shutdown, such as a low level alarm for a tank that is currently not in use.

IsSuppressedNode

Gets the OpcTwoStateVariableNode of the IsSuppressed property.

public OpcTwoStateVariableNode IsSuppressedNode { get; }

Public ReadOnly Property IsSuppressedNode As OpcTwoStateVariableNode

Property value

OpcTwoStateVariableNode

An instance of the OpcTwoStateVariableNode class.

IsSuppressedOrShelved

Gets a value indicating whether the alarm is either in the IsSuppressed or Shelving.

public bool IsSuppressedOrShelved { get; }

Public ReadOnly Property IsSuppressedOrShelved As Boolean

Property value

Boolean

The value true if the alarm is either in the IsSuppressed or Shelving; otherwise (if both are not present) the value false.

Remarks

In case there the value is false the client typically does not display the alarm. State transitions associated with the alarm do occur, but they are not typically displayed by the clients as long as the alarm remains in either the suppressed or shelved state.

IsSuppressedOrShelvedNode

Gets the OpcPropertyNode<T> of the IsSuppressedOrShelved property.

public OpcPropertyNode<bool> IsSuppressedOrShelvedNode { get; }

Public ReadOnly Property IsSuppressedOrShelvedNode As OpcPropertyNode(Of Boolean)

Property value

OpcPropertyNode<Boolean>

An instance of the OpcPropertyNode<T> class.

MaxTimeShelved

Gets or sets the maximum time that the alarm condition may be shelved.

public double MaxTimeShelved { get; set; }

Public Property MaxTimeShelved As Double

Property value

Double

The value is expressed as duration. Systems can use this property to prevent permanent shelving of an alarm. If this property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, than a BadShelvingTimeOutOfRange error code is returned on the call. If this property is present it will also be enforced for the OneShotShelved state, in that the alarm condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this property expires following a OneShotShelve operation without a change of any of the other items associated with the condition.

MaxTimeShelvedNode

Gets the OpcPropertyNode<T> of the MaxTimeShelved property.

public OpcPropertyNode<double> MaxTimeShelvedNode { get; }

Public ReadOnly Property MaxTimeShelvedNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

OneShotShelveCallback

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

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

Public Property OneShotShelveCallback As OpcNodeFunc(Of OpcAlarmConditionNode)

Property value

OpcNodeFunc<OpcAlarmConditionNode>

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

Shelving

Gets a node which is used to suggest whether an alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance alarms.

public OpcShelvedStateMachineNode Shelving { get; }

Public ReadOnly Property Shelving As OpcShelvedStateMachineNode

Property value

OpcShelvedStateMachineNode

An instance of the OpcShelvedStateMachineNode to suggest whether an alarm shall (temporarily) be prevented.

TimedShelveCallback

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

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

Public Property TimedShelveCallback As OpcNodeFunc(Of OpcAlarmConditionNode, TimeSpan)

Property value

OpcNodeFunc<OpcAlarmConditionNode, 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).

TimedUnshelveCallback

Gets or sets a callback used to unshelve the condition node after a specific amount of time being shelved.

public OpcNodeFunc<OpcAlarmConditionNode> TimedUnshelveCallback { get; set; }

Public Property TimedUnshelveCallback As OpcNodeFunc(Of OpcAlarmConditionNode)

Property value

OpcNodeFunc<OpcAlarmConditionNode>

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

UnshelveCallback

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

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

Public Property UnshelveCallback As OpcNodeFunc(Of OpcAlarmConditionNode)

Property value

OpcNodeFunc<OpcAlarmConditionNode>

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

Methods

CreateBranchCore

protected · override

Creates a new instance of the OpcAlarmConditionNode using the same Id and Name as this node.

protected override OpcConditionNode CreateBranchCore()

Protected Overrides Function CreateBranchCore() As OpcConditionNode

Returns

OpcConditionNode

A new instance of the OpcAlarmConditionNode identifiable and accessible througth the same Id and Name as this node.

Overrides

CreateBranchCore

OneShotShelveCore

protected · virtual

Shelves a condition node once using the context specified.

protected virtual OpcStatusCode OneShotShelveCore(
    OpcNodeContext<OpcAlarmConditionNode> context)

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

Parameters

Name	Type	Description
context	OpcNodeContext<OpcAlarmConditionNode>	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 Good if there is no custom callback routine defined.

TimedShelveCore

protected · virtual

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

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

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

Parameters

Name	Type	Description
context	OpcNodeContext<OpcAlarmConditionNode>	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 Good if there is no custom callback routine defined.

TimedUnshelveCore

protected · virtual

Unshelves a condition node using the context specified after being shelved for a specific amount of time.

protected virtual OpcStatusCode TimedUnshelveCore(
    OpcNodeContext<OpcAlarmConditionNode> context)

Protected Overridable Function TimedUnshelveCore(
    context As OpcNodeContext(Of OpcAlarmConditionNode)) As OpcStatusCode

Parameters

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

Returns

OpcStatusCode

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

UnshelveCore

protected · virtual

Unshelves a condition node using the context specified.

protected virtual OpcStatusCode UnshelveCore(
    OpcNodeContext<OpcAlarmConditionNode> context)

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

Parameters

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

Returns

OpcStatusCode

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