Reference

OpcAlarmCondition Members

Type

OpcAlarmCondition

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from OpcAcknowledgeableCondition, OpcCondition, OpcEvent.

Constructors

OpcAlarmCondition

since v2.8

Initializes a new instance of the OpcAlarmCondition class using the dataStore specified.

public OpcAlarmCondition(IOpcReadOnlyNodeDataStore dataStore)

Public Sub New(dataStore As IOpcReadOnlyNodeDataStore)

Parameters

Name	Type	Description
dataStore	IOpcReadOnlyNodeDataStore	The IOpcReadOnlyNodeDataStore of the 'Opc.UaFx.OpcAlarmConditionNode' to represent.

Exceptions

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

Properties

InputNodeId

Gets 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; }

Public ReadOnly Property InputNodeId As OpcNodeId

Property value

OpcNodeId

If this variable is not in the address space, Null is provided. For more information see 'Opc.UaFx.OpcAlarmConditionNode.InputNodeId'.

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. For more information see 'Opc.UaFx.OpcAlarmConditionNode.IsActive'.

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 more information 'Opc.UaFx.OpcAlarmConditionNode.IsSuppressed'.

IsSuppressedOrShelved

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

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 shelved; otherwise (if both are not present) the value false. For more information see 'Opc.UaFx.OpcAlarmConditionNode.IsSuppressedOrShelved'.

MaxTimeShelved

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

public double MaxTimeShelved { get; }

Public ReadOnly 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. For more information see 'Opc.UaFx.OpcAlarmConditionNode.MaxTimeShelved'.