Skip to content

Reference

OpcLimitAlarmNode Members

Defines an alarm condition node with multiple limits.

Reference

OpcLimitAlarmNode Members ​

Type
OpcLimitAlarmNode
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

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

Constructors ​

OpcLimitAlarmNode ​

18 overloads

OverloadDescription
OpcLimitAlarmNode(OpcName)since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified.
OpcLimitAlarmNode(OpcName, OpcLimitAlarmStates)Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and supportedLimits specified.
OpcLimitAlarmNode(OpcName, OpcNodeId)since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified.
OpcLimitAlarmNode(OpcName, OpcNodeId, OpcLimitAlarmStates)Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id with the supportedLimits specified.
OpcLimitAlarmNode(IOpcNode, OpcName)since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified as a child node of the parent node given.
OpcLimitAlarmNode(IOpcNode, OpcName, OpcLimitAlarmStates)Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified as a child node of the parent node given.
OpcLimitAlarmNode(IOpcNode, OpcName, OpcNodeId)since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified as a child node of the parent node given.
OpcLimitAlarmNode(IOpcNode, OpcName, OpcNodeId, OpcLimitAlarmStates)Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified as a child node of the parent node given.
OpcLimitAlarmNode(LimitAlarmState)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class using the content as the instance to wrap.
OpcLimitAlarmNode(LimitAlarmState, OpcNodeModel)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class using the content as the instance to wrap.
OpcLimitAlarmNode(OpcNodeModel, OpcName)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified.
OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcLimitAlarmStates)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and supportedLimits specified.
OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcNodeId)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified.
OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcNodeId, OpcLimitAlarmStates)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id with the supportedLimits specified.
OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified as a child node of the parent node given.
OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcLimitAlarmStates)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name specified as a child node of the parent node given.
OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified as a child node of the parent node given.
OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId, OpcLimitAlarmStates)protected · since v2.50Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id specified as a child node of the parent node given.

OpcLimitAlarmNode(OpcName) ​

since v2.50

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

csharp
public OpcLimitAlarmNode(OpcName name)
vbnet
Public Sub New(name As OpcName)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.

OpcLimitAlarmNode(OpcName, OpcLimitAlarmStates) ​

Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and supportedLimits specified.

csharp
public OpcLimitAlarmNode(OpcName name, OpcLimitAlarmStates supportedLimits)
vbnet
Public Sub New(name As OpcName, supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(OpcName, OpcNodeId) ​

since v2.50

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

csharp
public OpcLimitAlarmNode(OpcName name, OpcNodeId id)
vbnet
Public Sub New(name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.

OpcLimitAlarmNode(OpcName, OpcNodeId, OpcLimitAlarmStates) ​

Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id with the supportedLimits specified.

csharp
public OpcLimitAlarmNode(
    OpcName name,
    OpcNodeId id,
    OpcLimitAlarmStates supportedLimits)
vbnet
Public Sub New(
    name As OpcName,
    id As OpcNodeId,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(IOpcNode, OpcName) ​

since v2.50

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

csharp
public OpcLimitAlarmNode(IOpcNode parent, OpcName name)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.

OpcLimitAlarmNode(IOpcNode, OpcName, OpcLimitAlarmStates) ​

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

csharp
public OpcLimitAlarmNode(
    IOpcNode parent,
    OpcName name,
    OpcLimitAlarmStates supportedLimits)
vbnet
Public Sub New(
    parent As IOpcNode,
    name As OpcName,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(IOpcNode, OpcName, OpcNodeId) ​

since v2.50

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

csharp
public OpcLimitAlarmNode(IOpcNode parent, OpcName name, OpcNodeId id)
vbnet
Public Sub New(parent As IOpcNode, name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.

OpcLimitAlarmNode(IOpcNode, OpcName, OpcNodeId, OpcLimitAlarmStates) ​

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

csharp
public OpcLimitAlarmNode(
    IOpcNode parent,
    OpcName name,
    OpcNodeId id,
    OpcLimitAlarmStates supportedLimits)
vbnet
Public Sub New(
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(LimitAlarmState) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(LimitAlarmState content)
vbnet
Protected Sub New(content As LimitAlarmState)

Parameters

NameTypeDescription
contentLimitAlarmStateThe LimitAlarmState to wrap.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe content is a null reference (Nothing in Visual Basic).

OpcLimitAlarmNode(LimitAlarmState, OpcNodeModel) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(LimitAlarmState content, OpcNodeModel model)
vbnet
Protected Sub New(content As LimitAlarmState, model As OpcNodeModel)

Parameters

NameTypeDescription
contentLimitAlarmStateThe LimitAlarmState to wrap.
modelOpcNodeModelThe 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

ExceptionCondition
ArgumentNullExceptionThe content is a null reference (Nothing in Visual Basic).

OpcLimitAlarmNode(OpcNodeModel, OpcName) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(OpcNodeModel model, OpcName name)
vbnet
Protected Sub New(model As OpcNodeModel, name As OpcName)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.

OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcLimitAlarmStates) ​

protected · since v2.50

Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and supportedLimits specified.

csharp
protected OpcLimitAlarmNode(
    OpcNodeModel model,
    OpcName name,
    OpcLimitAlarmStates supportedLimits)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    name As OpcName,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcNodeId) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(OpcNodeModel model, OpcName name, OpcNodeId id)
vbnet
Protected Sub New(model As OpcNodeModel, name As OpcName, id As OpcNodeId)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.

OpcLimitAlarmNode(OpcNodeModel, OpcName, OpcNodeId, OpcLimitAlarmStates) ​

protected · since v2.50

Initializes a new instance of the OpcLimitAlarmNode class accessible by the name and id with the supportedLimits specified.

csharp
protected OpcLimitAlarmNode(
    OpcNodeModel model,
    OpcName name,
    OpcNodeId id,
    OpcLimitAlarmStates supportedLimits)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    name As OpcName,
    id As OpcNodeId,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(OpcNodeModel model, IOpcNode parent, OpcName name)
vbnet
Protected Sub New(model As OpcNodeModel, parent As IOpcNode, name As OpcName)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.

OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcLimitAlarmStates) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcLimitAlarmStates supportedLimits)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcNodeId id)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.

OpcLimitAlarmNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId, OpcLimitAlarmStates) ​

protected · since v2.50

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

csharp
protected OpcLimitAlarmNode(
    OpcNodeModel model,
    IOpcNode parent,
    OpcName name,
    OpcNodeId id,
    OpcLimitAlarmStates supportedLimits)
vbnet
Protected Sub New(
    model As OpcNodeModel,
    parent As IOpcNode,
    name As OpcName,
    id As OpcNodeId,
    supportedLimits As OpcLimitAlarmStates)

Parameters

NameTypeDescription
modelOpcNodeModelThe 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.
parentIOpcNodeThe IOpcNode used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.
nameOpcNameThe OpcName through that the new limit alarm node can be accessed.
idOpcNodeIdThe OpcNodeId through that the new limit alarm node can be identified and accessed.
supportedLimitsOpcLimitAlarmStatesOne or more members defined by the OpcLimitAlarmStates enumeration identifying the limits defined by the alarm.

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.

csharp
protected override OpcNodeId DefaultTypeDefinitionId { get; }
vbnet
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

HighHighLimit ​

Gets or sets a value which indicates the high high limit of a value to test for the alarm condition.

csharp
public double HighHighLimit { get; set; }
vbnet
Public Property HighHighLimit As Double

Property value

Double

The optional high high limit to test.

Remarks

The property is optional but at least one of the limit properties is required to apply limits to the alarm condition. For cases where an underlying system cannot provide the actual value of a limit, the limit property will still be provided, but will have its access level set to not readable. It is assumed that the limits are described using the same engineering unit that is assigned to the variable that is the source of the alarm. For rate of change limit alarms, it is assumed this rate is units per second unless otherwise specified.

HighHighLimitNode ​

Gets the OpcPropertyNode<T> of the HighHighLimit property.

csharp
public OpcPropertyNode<double> HighHighLimitNode { get; }
vbnet
Public ReadOnly Property HighHighLimitNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

HighLimit ​

Gets or sets a value which indicates the high limit of a value to test for the alarm condition.

csharp
public double HighLimit { get; set; }
vbnet
Public Property HighLimit As Double

Property value

Double

The optional high limit to test.

Remarks

The property is optional but at least one of the limit properties is required to apply limits to the alarm condition. For cases where an underlying system cannot provide the actual value of a limit, the limit property will still be provided, but will have its access level set to not readable. It is assumed that the limits are described using the same engineering unit that is assigned to the variable that is the source of the alarm. For rate of change limit alarms, it is assumed this rate is units per second unless otherwise specified.

HighLimitNode ​

Gets the OpcPropertyNode<T> of the HighLimit property.

csharp
public OpcPropertyNode<double> HighLimitNode { get; }
vbnet
Public ReadOnly Property HighLimitNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

LowLimit ​

Gets or sets a value which indicates the low limit of a value to test for the alarm condition.

csharp
public double LowLimit { get; set; }
vbnet
Public Property LowLimit As Double

Property value

Double

The optional low limit to test.

Remarks

The property is optional but at least one of the limit properties is required to apply limits to the alarm condition. For cases where an underlying system cannot provide the actual value of a limit, the limit property will still be provided, but will have its access level set to not readable. It is assumed that the limits are described using the same engineering unit that is assigned to the variable that is the source of the alarm. For rate of change limit alarms, it is assumed this rate is units per second unless otherwise specified.

LowLimitNode ​

Gets the OpcPropertyNode<T> of the LowLimit property.

csharp
public OpcPropertyNode<double> LowLimitNode { get; }
vbnet
Public ReadOnly Property LowLimitNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

LowLowLimit ​

Gets or sets a value which indicates the low low limit of a value to test for the alarm condition.

csharp
public double LowLowLimit { get; set; }
vbnet
Public Property LowLowLimit As Double

Property value

Double

The optional low low limit to test.

Remarks

The property is optional but at least one of the limit properties is required to apply limits to the alarm condition. For cases where an underlying system cannot provide the actual value of a limit, the limit property will still be provided, but will have its access level set to not readable. It is assumed that the limits are described using the same engineering unit that is assigned to the variable that is the source of the alarm. For rate of change limit alarms, it is assumed this rate is units per second unless otherwise specified.

LowLowLimitNode ​

Gets the OpcPropertyNode<T> of the LowLowLimit property.

csharp
public OpcPropertyNode<double> LowLowLimitNode { get; }
vbnet
Public ReadOnly Property LowLowLimitNode As OpcPropertyNode(Of Double)

Property value

OpcPropertyNode<Double>

An instance of the OpcPropertyNode<T> class.

SupportedLimits ​

Gets a combination of the values defined by the OpcLimitAlarmStates enumeration which defines the different limit states the OpcLimitAlarmNode supports.

csharp
public OpcLimitAlarmStates SupportedLimits { get; }
vbnet
Public ReadOnly Property SupportedLimits As OpcLimitAlarmStates

Property value

OpcLimitAlarmStates

A combination of the members defined by the OpcLimitAlarmStates enumeration.

Methods ​

CreateBranchCore ​

protected · override

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

csharp
protected override OpcConditionNode CreateBranchCore()
vbnet
Protected Overrides Function CreateBranchCore() As OpcConditionNode

Returns

OpcConditionNode

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

Overrides

CreateBranchCore

InitializeDefaults ​

protected · override

Initializes the default values used by the OpcLimitAlarmNode.

csharp
protected override void InitializeDefaults()
vbnet
Protected Overrides Sub InitializeDefaults()

Overrides

InitializeDefaults

Remarks

This method is used to ensure the availability of appropriate node specific default values. For more information like when this method is to be overwritten see InitializeDefaults.