Book Creator
 Add this page to your book

Book Creator
 Remove this page from your book  

 Manage book (0 page(s))

 Help

~~NOTRANS~~ ====== OpcLimitAlarmNode Members ====== **Namespace:** Opc.UaFx \\ **Assemblies:** Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll \\ The [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] type exposes the following members. ===== Constructors ===== ==== OpcLimitAlarmNode(IOpcNode, OpcName, OpcLimitAlarmStates) ==== <panel> Initializes a new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] class accessible by the ''name'' specified as a child node of the ''parent'' node given. **C#** \\ <code csharp> public OpcLimitAlarmNode(IOpcNode parent, OpcName name, OpcLimitAlarmStates supportedLimits) </code> \\ **Parameters** ''parent'' [[Opc.UaFx.IOpcNode|IOpcNode]] \\ The [[Opc.UaFx.IOpcNode|IOpcNode]] used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.\\ ''name'' [[Opc.UaFx.OpcName|OpcName]] \\ The [[Opc.UaFx.OpcName|OpcName]] through that the new limit alarm node can be accessed.\\ ''supportedLimits'' [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] \\ One or more members defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration identifying the limits defined by the alarm.\\ </panel> ==== OpcLimitAlarmNode(IOpcNode, OpcName, OpcNodeId, OpcLimitAlarmStates) ==== <panel> Initializes a new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] class accessible by the ''name'' and ''id'' specified as a child node of the ''parent'' node given. **C#** \\ <code csharp> public OpcLimitAlarmNode(IOpcNode parent, OpcName name, OpcNodeId id, OpcLimitAlarmStates supportedLimits) </code> \\ **Parameters** ''parent'' [[Opc.UaFx.IOpcNode|IOpcNode]] \\ The [[Opc.UaFx.IOpcNode|IOpcNode]] used as the parent node or a null reference (Nothing in Visual Basic) in the case there is no parent node available.\\ ''name'' [[Opc.UaFx.OpcName|OpcName]] \\ The [[Opc.UaFx.OpcName|OpcName]] through that the new limit alarm node can be accessed.\\ ''id'' [[Opc.UaFx.OpcNodeId|OpcNodeId]] \\ The [[Opc.UaFx.OpcNodeId|OpcNodeId]] through that the new limit alarm node can be identified and accessed.\\ ''supportedLimits'' [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] \\ One or more members defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration identifying the limits defined by the alarm.\\ </panel> ==== OpcLimitAlarmNode(OpcName, OpcLimitAlarmStates) ==== <panel> Initializes a new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] class accessible by the ''name'' and ''supportedLimits'' specified. **C#** \\ <code csharp> public OpcLimitAlarmNode(OpcName name, OpcLimitAlarmStates supportedLimits) </code> \\ **Parameters** ''name'' [[Opc.UaFx.OpcName|OpcName]] \\ The [[Opc.UaFx.OpcName|OpcName]] through that the new limit alarm node can be accessed.\\ ''supportedLimits'' [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] \\ One or more members defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration identifying the limits defined by the alarm.\\ </panel> ==== OpcLimitAlarmNode(OpcName, OpcNodeId, OpcLimitAlarmStates) ==== <panel> Initializes a new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] class accessible by the ''name'' and ''id'' with the ''supportedLimits'' specified. **C#** \\ <code csharp> public OpcLimitAlarmNode(OpcName name, OpcNodeId id, OpcLimitAlarmStates supportedLimits) </code> \\ **Parameters** ''name'' [[Opc.UaFx.OpcName|OpcName]] \\ The [[Opc.UaFx.OpcName|OpcName]] through that the new limit alarm node can be accessed.\\ ''id'' [[Opc.UaFx.OpcNodeId|OpcNodeId]] \\ The [[Opc.UaFx.OpcNodeId|OpcNodeId]] through that the new limit alarm node can be identified and accessed.\\ ''supportedLimits'' [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] \\ One or more members defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration identifying the limits defined by the alarm.\\ </panel> ===== Properties ===== ==== DefaultTypeDefinitionId ==== <panel> Gets the default identifier which identifies the node that defines the underlying node type from that this [[Opc.UaFx.OpcInstanceNode|OpcInstanceNode]] has been created. **C#** \\ <code csharp> protected override OpcNodeId DefaultTypeDefinitionId { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeId|OpcNodeId]] \\ The [[Opc.UaFx.OpcNodeId|OpcNodeId]] of the type node from that this [[Opc.UaFx.OpcInstanceNode|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). </panel> ==== HighHighLimit ==== <panel> Gets or sets a value which indicates the high high limit of a value to test for the alarm condition. **C#** \\ <code csharp> public double HighHighLimit { get; set; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.double|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. </panel> ==== HighHighLimitNode ==== <panel> Gets the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] of the [[Opc.UaFx.OpcLimitAlarmNodeMembers#HighHighLimit|HighHighLimit]] property. **C#** \\ <code csharp> public OpcPropertyNode<double> HighHighLimitNode { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcPropertyNode|OpcPropertyNode]]<[[https://docs.microsoft.com/en-us/dotnet/api/system.double|Double]]> \\ An instance of the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] class. </panel> ==== HighLimit ==== <panel> Gets or sets a value which indicates the high limit of a value to test for the alarm condition. **C#** \\ <code csharp> public double HighLimit { get; set; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.double|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. </panel> ==== HighLimitNode ==== <panel> Gets the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] of the [[Opc.UaFx.OpcLimitAlarmNodeMembers#HighLimit|HighLimit]] property. **C#** \\ <code csharp> public OpcPropertyNode<double> HighLimitNode { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcPropertyNode|OpcPropertyNode]]<[[https://docs.microsoft.com/en-us/dotnet/api/system.double|Double]]> \\ An instance of the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] class. </panel> ==== LowLimit ==== <panel> Gets or sets a value which indicates the low limit of a value to test for the alarm condition. **C#** \\ <code csharp> public double LowLimit { get; set; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.double|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. </panel> ==== LowLimitNode ==== <panel> Gets the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] of the [[Opc.UaFx.OpcLimitAlarmNodeMembers#LowLimit|LowLimit]] property. **C#** \\ <code csharp> public OpcPropertyNode<double> LowLimitNode { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcPropertyNode|OpcPropertyNode]]<[[https://docs.microsoft.com/en-us/dotnet/api/system.double|Double]]> \\ An instance of the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] class. </panel> ==== LowLowLimit ==== <panel> Gets or sets a value which indicates the low low limit of a value to test for the alarm condition. **C#** \\ <code csharp> public double LowLowLimit { get; set; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.double|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. </panel> ==== LowLowLimitNode ==== <panel> Gets the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] of the [[Opc.UaFx.OpcLimitAlarmNodeMembers#LowLowLimit|LowLowLimit]] property. **C#** \\ <code csharp> public OpcPropertyNode<double> LowLowLimitNode { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcPropertyNode|OpcPropertyNode]]<[[https://docs.microsoft.com/en-us/dotnet/api/system.double|Double]]> \\ An instance of the [[Opc.UaFx.OpcPropertyNode-1|OpcPropertyNode´1]] class. </panel> ==== SupportedLimits ==== <panel> Gets a combination of the values defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration which defines the different limit states the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] supports. **C#** \\ <code csharp> public OpcLimitAlarmStates SupportedLimits { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] \\ A combination of the members defined by the [[Opc.UaFx.OpcLimitAlarmStates|OpcLimitAlarmStates]] enumeration. </panel> ===== Methods ===== ==== CreateBranchCore() ==== <panel> Creates a new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] using the same [[Opc.UaFx.OpcNodeMembers#Id|Id]] and [[Opc.UaFx.OpcNodeMembers#Name|Name]] as this node. **C#** \\ <code csharp> protected override OpcConditionNode CreateBranchCore() </code> \\ **Returns** [[Opc.UaFx.OpcConditionNode|OpcConditionNode]] \\ A new instance of the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]] identifiable and accessible througth the same [[Opc.UaFx.OpcNodeMembers#Id|Id]] and [[Opc.UaFx.OpcNodeMembers#Name|Name]] as this node. </panel> ==== InitializeDefaults() ==== <panel> Initializes the default values used by the [[Opc.UaFx.OpcLimitAlarmNode|OpcLimitAlarmNode]]. **C#** \\ <code csharp> protected override void InitializeDefaults() </code> \\ **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 [[Opc.UaFx.OpcNodeMembers#InitializeDefaults|InitializeDefaults]]. </panel>