.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaServer.LimitAlarmModel Class Reference

An abstract type used to provide a base Type for AlarmConditions with multiple limits More...

Inherits UnifiedAutomation.UaServer.AlarmConditionModel.

Inherited by UnifiedAutomation.UaServer.ExclusiveLimitAlarmModel, and UnifiedAutomation.UaServer.NonExclusiveLimitAlarmModel.

Public Member Functions

 LimitAlarmModel ()
 Initializes a new instance of the LimitAlarmModel class. More...
 
 LimitAlarmModel (LimitAlarmModel template)
 Initializes a new instance of the LimitAlarmModel class. More...
 
override void UpdateEvent (GenericEvent e)
 Updates the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.AlarmConditionModel
StatusCode OneShotShelve (RequestContext context)
 Shelves an alarm. More...
 
StatusCode TimedShelve (RequestContext context, double shelvingTime)
 Shelves an alarm for the specified time. More...
 
StatusCode Unshelve (RequestContext context)
 Unshelves an alarm. More...
 
virtual StatusCode Suppress (RequestContext context, bool suppress)
 Suppresses an alarm. More...
 
virtual StatusCode Activate (RequestContext context, bool active)
 Activates an alarm More...
 
override void UpdateEnabledEffectiveDisplayName ()
 Updates the effect display name for the enabled state. More...
 
virtual void UpdateActiveEffectiveDisplayName ()
 Updates the effective display name for the active state. More...
 
 AlarmConditionModel ()
 Initializes a new instance of the AlarmConditionModel class. More...
 
 AlarmConditionModel (AlarmConditionModel template)
 Initializes a new instance of the AlarmConditionModel class. More...
 
override CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
 Gets the method dispatcher. More...
 
override StatusCode DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)
 Dispatches the method. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.AcknowledgeableConditionModel
virtual StatusCode Acknowledge (RequestContext context, byte[] eventId, LocalizedText comment)
 Acknowledges an Event Notification for a Condition instance state where AckedState was set to FALSE. More...
 
virtual StatusCode Confirm (RequestContext context, byte[] eventId, LocalizedText comment)
 Confirms an Event Notification for a Condition instance state where ConfirmedState was set to FALSE. More...
 
virtual void ResetAcked (RequestContext context)
 Sets the state to unacknownledged and unconfirmed. More...
 
 AcknowledgeableConditionModel ()
 Initializes a new instance of the AcknowledgeableConditionModel class. More...
 
 AcknowledgeableConditionModel (AcknowledgeableConditionModel template)
 Initializes a new instance of the AcknowledgeableConditionModel class. More...
 
override CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
 Gets the method dispatcher. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ConditionModel
virtual StatusCode Enable (RequestContext context)
 Changes a Condition instance to the Disabled state. More...
 
virtual StatusCode Disable (RequestContext context)
 Change a Condition instance to the enabled state. More...
 
virtual StatusCode AddComment (RequestContext context, byte[] eventId, LocalizedText comment)
 Applies a comment to a specific state of a Condition instance. More...
 
 ConditionModel ()
 Initializes a new instance of the ConditionModel class. More...
 
 ConditionModel (ConditionModel template)
 Initializes a new instance of the ConditionModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseEventModel
 BaseEventModel ()
 Initializes a new instance of the BaseEventModel class. More...
 
 BaseEventModel (BaseEventModel template)
 Initializes a new instance of the BaseEventModel class. More...
 
void NewId ()
 Assigns a new EventId, Time and ReceiveTime to the event. More...
 
virtual GenericEvent CreateEvent (FilterManager manager)
 Creates the event. More...
 
virtual GenericEvent CreateEvent (FilterManager manager, bool autoGenerateEventIdAndTime)
 Creates the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 

Properties

double BaseHighHighLimit [get, set]
 Gets or sets the BaseHighHighLimit More...
 
double BaseHighLimit [get, set]
 Gets or sets the BaseHighLimit More...
 
double BaseLowLimit [get, set]
 Gets or sets the BaseLowLimit More...
 
double BaseLowLowLimit [get, set]
 Gets or sets the BaseLowLowLimit More...
 
double HighHighLimit [get, set]
 Gets or sets the HighHighLimit More...
 
double HighLimit [get, set]
 Gets or sets the HighLimit More...
 
double LowLimit [get, set]
 Gets or sets the LowLimit More...
 
double LowLowLimit [get, set]
 Gets or sets the LowLowLimit More...
 
- Properties inherited from UnifiedAutomation.UaServer.AlarmConditionModel
TwoStateVariableModel ActiveState [get, set]
 ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists. More...
 
bool AudibleEnabled [get, set]
 Gets or sets the AudibleEnabled More...
 
byte[] AudibleSound [get, set]
 Gets or sets the AudibleSound More...
 
new TwoStateVariableModel EnabledState [get, set]
 Gets or sets the EnabledState More...
 
AlarmGroupModel FirstInGroup [get, set]
 Gets or sets the FirstInGroup More...
 
bool FirstInGroupFlag [get, set]
 Gets or sets the FirstInGroupFlag More...
 
NodeId InputNode [get, set]
 Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. More...
 
TwoStateVariableModel LatchedState [get, set]
 Gets or sets the LatchedState More...
 
double MaxTimeShelved [get, set]
 Optional Property used to set the maximum time that an Alarm Condition may be shelved. More...
 
double OffDelay [get, set]
 Gets or sets the OffDelay More...
 
double OnDelay [get, set]
 Gets or sets the OnDelay More...
 
TwoStateVariableModel OutOfServiceState [get, set]
 Gets or sets the OutOfServiceState More...
 
short ReAlarmRepeatCount [get, set]
 Gets or sets the ReAlarmRepeatCount More...
 
double ReAlarmTime [get, set]
 Gets or sets the ReAlarmTime More...
 
ShelvedStateMachineModel ShelvingState [get, set]
 Suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. More...
 
TwoStateVariableModel SilenceState [get, set]
 Gets or sets the SilenceState More...
 
bool SuppressedOrShelved [get, set]
 The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. More...
 
TwoStateVariableModel SuppressedState [get, set]
 Used internally by a Server to automatically suppress Alarms due to system specific reasons. More...
 
- Properties inherited from UnifiedAutomation.UaServer.AcknowledgeableConditionModel
TwoStateVariableModel AckedState [get, set]
 AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. More...
 
TwoStateVariableModel ConfirmedState [get, set]
 Indicates whether the Condition requires confirmation. More...
 
new TwoStateVariableModel EnabledState [get, set]
 Gets or sets the EnabledState More...
 
- Properties inherited from UnifiedAutomation.UaServer.ConditionModel
NodeId BranchId [get, set]
 
string ClientUserId [get, set]
 Is related to the Comment field and contains the identity of the user who inserted the most recent Comment. More...
 
ConditionVariableModel
< LocalizedText
Comment [get, set]
 Contains the last comment provided for a certain state (ConditionBranch). More...
 
NodeId ConditionClassId [get, set]
 Specifies in which domain this Condition is used. More...
 
LocalizedText ConditionClassName [get, set]
 
string ConditionName [get, set]
 Identifies the Condition instance that the Event originated from. More...
 
NodeId[] ConditionSubClassId [get, set]
 Gets or sets the ConditionSubClassId More...
 
LocalizedText[] ConditionSubClassName [get, set]
 Gets or sets the ConditionSubClassName More...
 
TwoStateVariableModel EnabledState [get, set]
 EnabledState indicates whether the Condition is enabled. More...
 
ConditionVariableModel< ushort > LastSeverity [get, set]
 Provides the previous severity of the ConditionBranch. More...
 
ConditionVariableModel
< StatusCode
Quality [get, set]
 Reveals the status of process values or other resources that this Condition instance is based upon. More...
 
bool Retain [get, set]
 
IConditionMethods ConditionMethods [get, set]
 Gets or sets the Condition methods. More...
 
- Properties inherited from UnifiedAutomation.UaServer.BaseEventModel
NodeId NodeId [get, set]
 The node identifier for a representation of an event in the Server address space. Used mainly for ConditionIds. More...
 
byte[] EventId [get, set]
 Generated by the server to uniquely identify a particular Event Notification. More...
 
NodeId EventType [get, set]
 Describes the specific type of Event. More...
 
NodeId SourceNode [get, set]
 Identifies the Node that the Event originated from. More...
 
string SourceName [get, set]
 Provides a description of the source of the Event. More...
 
DateTime Time [get, set]
 Provides the time the Event occurred. More...
 
DateTime ReceiveTime [get, set]
 Provides the time the OPC UA Server received the Event from the underlying device of another Server. More...
 
TimeZoneDataType LocalTime [get, set]
 Contains the Offset and the DaylightSavingInOffset flag. More...
 
LocalizedText Message [get, set]
 Provides a human-readable and localizable text description of the Event. More...
 
ushort Severity [get, set]
 An indication of the urgency of the Event. More...
 
INodeAccessInfo NodeAccessInfo [get, set]
 Using a NodeAccessInfo can restrict the access of an event to single scopes. More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 

Detailed Description

An abstract type used to provide a base Type for AlarmConditions with multiple limits

Alarms can be modelled with multiple exclusive substates and assigned limits or they may be modelled with non exclusive limits that can be used to group multiple states together.

Four optional limits are defined that configure the states of the derived limit Alarm Types: HighHighLimit, HighLimit, LowLimit, and LowLowLimit. These Properties shall be set for any Alarm limits that are exposed by the derived limit Alarm Types. These Properties are listed as optional but at least one is required. For cases where an underlying system cannot provide the actual value of a limit, the limit Property shall still be provided, but will have its AccessLevel 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.

The Alarm limits listed may cause an Alarm to be generated when a value equals the limit or it may generate the Alarm when the limit is exceeded, (i.e. the Value is above the limit for HighLimit and below the limit for LowLimit). The exact behaviour when the value is equal to the limit is Server specific.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.LimitAlarmModel.LimitAlarmModel ( )
inline

Initializes a new instance of the LimitAlarmModel class.

UnifiedAutomation.UaServer.LimitAlarmModel.LimitAlarmModel ( LimitAlarmModel  template)
inline

Initializes a new instance of the LimitAlarmModel class.

Parameters
templateThe template.

Member Function Documentation

Property Documentation

double UnifiedAutomation.UaServer.LimitAlarmModel.BaseHighHighLimit
getset

Gets or sets the BaseHighHighLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.BaseHighLimit
getset

Gets or sets the BaseHighLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.BaseLowLimit
getset

Gets or sets the BaseLowLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.BaseLowLowLimit
getset

Gets or sets the BaseLowLowLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.HighHighLimit
getset

Gets or sets the HighHighLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.HighLimit
getset

Gets or sets the HighLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.LowLimit
getset

Gets or sets the LowLimit

double UnifiedAutomation.UaServer.LimitAlarmModel.LowLowLimit
getset

Gets or sets the LowLowLimit


The documentation for this class was generated from the following file: