Skip to content

Reference

OpcAlarmConditionNode Class

Defines an acknowledgeable condition node which introduces additional states to define active, suppressed and shelving alarm conditions.

Reference

OpcAlarmConditionNode Class ​

Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Members
OpcAlarmConditionNode Members

Defines an acknowledgeable condition node which introduces additional states to define active, suppressed and shelving alarm conditions.

Syntax ​

csharp
[OpcEventType(typeof(OpcAlarmCondition))]
[OpcNodeType(2915)]
public class OpcAlarmConditionNode : OpcAcknowledgeableConditionNode
vbnet
<OpcEventType(GetType(OpcAlarmCondition))>
<OpcNodeType(2915)>
Public Class OpcAlarmConditionNode
    Inherits OpcAcknowledgeableConditionNode

Inheritance ​

Object → OpcNode → OpcInstanceNode → OpcObjectNode → OpcEventNode → OpcConditionNode → OpcAcknowledgeableConditionNode → OpcAlarmConditionNode

Implements ​

Derived types ​

Constructors ​

NameDescription
OpcAlarmConditionNode10 overloadsInitializes a new instance of the OpcAlarmConditionNode class accessible by the name specified.

Properties ​

NameDescription
DefaultTypeDefinitionIdprotected · overrideGets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.
InputNodeIdGets 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.
InputNodeIdNodeGets the OpcNodeIdPropertyNode of the InputNodeId property.
IsActiveGets a value indicating whether the alarm situation represented currently exists.
IsActiveNodeGets the OpcTwoStateVariableNode of the IsActive property.
IsSuppressedGets a value indicating whether the alarm is suppressed due to system specific reasons.
IsSuppressedNodeGets the OpcTwoStateVariableNode of the IsSuppressed property.
IsSuppressedOrShelvedGets a value indicating whether the alarm is either in the IsSuppressed or Shelving.
IsSuppressedOrShelvedNodeGets the OpcPropertyNode<T> of the IsSuppressedOrShelved property.
MaxTimeShelvedGets or sets the maximum time that the alarm condition may be shelved.
MaxTimeShelvedNodeGets the OpcPropertyNode<T> of the MaxTimeShelved property.
OneShotShelveCallbackGets or sets a callback used to shelve the condition node once.
ShelvingGets a node which is used to suggest whether an alarm shall (temporarily) be prevented from being displayed to the user.
TimedShelveCallbackGets or sets a callback used to shelve the condition node for a specific amount of time.
TimedUnshelveCallbackGets or sets a callback used to unshelve the condition node after a specific amount of time being shelved.
UnshelveCallbackGets or sets a callback used to unshelve the condition node.

Methods ​

NameDescription
CreateBranchCoreprotected · overrideCreates a new instance of the OpcAlarmConditionNode using the same Id and Name as this node.
OneShotShelveCoreprotected · virtualShelves a condition node once using the context specified.
TimedShelveCoreprotected · virtualShelves a condition node using the context and duration information specified.
TimedUnshelveCoreprotected · virtualUnshelves a condition node using the context specified after being shelved for a specific amount of time.
UnshelveCoreprotected · virtualUnshelves a condition node using the context specified.

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

Extension methods ​

NameDescription
OpcAcknowledgeableConditionNodeExtension.AcknowledgeAcknowledges an event notification which can be identified by the EventId of the conditionNode specified there the IsAckedNode is equals to its false state using the further specified client.
OpcAcknowledgeableConditionNodeExtension.ConfirmConfirms an event notification which can be identified by the EventId of the conditionNode specified there the IsConfirmedNode is equals to its false state using the further specified client.
OpcConditionNodeExtension.AddCommentApplies a comment to the state reported by an event notification which can be identified by the EventId of the conditionNode specified using the further specified client.
OpcConditionNodeExtension.ChangeCommentChanges the condition 'Comment' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeIsAckedChanges the condition 'Acked' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeIsActiveChanges the condition 'Active' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeIsConfirmedChanges the condition 'Confirmed' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeIsEnabledChanges the condition 'Enabled' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeIsSuppressedChanges the condition 'Suppressed' state of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeSeverityChanges the condition 'Severity' of the conditionNode specified using the further specified context without raising change events.
OpcConditionNodeExtension.ChangeShelvingChanges the condition 'Shelving' of the conditionNode specified using the further specified context.
OpcConditionNodeExtension.DisableChanges the condition state to 'Disabled' of the conditionNode specified using the further specified client.
OpcConditionNodeExtension.EnableChanges the condition state to 'Enabled' of the conditionNode specified using the further specified client.

Applies to ​

PackageVersions
Opc.UaFx.Advancedv2.5–v2.59