UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel Class Reference

A special level Alarm utilized with one or more non-exclusive states. More...

Inherits UnifiedAutomation.UaServer.NonExclusiveLimitAlarmModel.

Public Member Functions
void	Evaluate (double value, double setpoint)
	Evaluates the given value. More...
	NonExclusiveDeviationAlarmModel ()
	Initializes a new instance of the NonExclusiveDeviationAlarmModel class. More...
	NonExclusiveDeviationAlarmModel (NonExclusiveDeviationAlarmModel template)
	Initializes a new instance of the NonExclusiveDeviationAlarmModel class. More...
override void	UpdateEvent (GenericEvent e)
	Updates the event. More...
Public Member Functions inherited from UnifiedAutomation.UaServer.NonExclusiveLimitAlarmModel
override void	Evaluate (double value)
	Evaluates the given value. More...
	NonExclusiveLimitAlarmModel ()
	Initializes a new instance of the NonExclusiveLimitAlarmModel class. More...
	NonExclusiveLimitAlarmModel (NonExclusiveLimitAlarmModel template)
	Initializes a new instance of the NonExclusiveLimitAlarmModel class. More...
Public Member Functions inherited from UnifiedAutomation.UaServer.LimitAlarmModel
	LimitAlarmModel ()
	Initializes a new instance of the LimitAlarmModel class. More...
	LimitAlarmModel (LimitAlarmModel template)
	Initializes a new instance of the LimitAlarmModel class. More...
Public Member Functions inherited from UnifiedAutomation.UaServer.AlarmConditionModel
StatusCode	OneShotShelve (LocalizedText comment, string clientUserId)
	Shelves an alarm. More...
StatusCode	OneShotShelve ()
	Shelves an alarm. More...
StatusCode	OneShotShelve (RequestContext context)
	Shelves an alarm. More...
StatusCode	TimedShelve (LocalizedText comment, string clientUserId)
	Shelves an alarm for a defined time period. More...
StatusCode	TimedShelve ()
	Shelves an alarm for a defined time period. More...
StatusCode	TimedShelve (RequestContext context, double shelvingTime)
	Shelves an alarm for a defined time period. More...
StatusCode	Unshelve (LocalizedText comment, string clientUserId)
	Unshelves an alarm. More...
StatusCode	Unshelve ()
	Unshelves an alarm. More...
StatusCode	Unshelve (RequestContext context)
	Unshelves an alarm. More...
virtual StatusCode	Suppress (LocalizedText comment, string clientUserId)
	Suppresses an alarm. More...
virtual StatusCode	Suppress ()
	Suppress an alarm. More...
virtual StatusCode	Unsuppress (LocalizedText comment, string clientUserId)
	Unsuppresses an alarm. More...
virtual StatusCode	Unsuppress ()
	Unsuppress an alarm. More...
virtual StatusCode	Suppress (RequestContext context, bool suppress)
	Suppress an alarm. More...
virtual StatusCode	RemoveFromService (LocalizedText comment, string clientUserId)
	Puts an alarm out of service. More...
virtual StatusCode	RemoveFromService ()
	Puts an alarm out of service. More...
virtual StatusCode	PlaceInService (LocalizedText comment, string clientUserId)
	Puts an alarm in service. More...
virtual StatusCode	PlaceInService ()
	Puts an alarm in service. More...
virtual StatusCode	Reset (LocalizedText comment, string clientUserId)
	The Reset Method is used reset a latched Alarm instance. More...
virtual StatusCode	Reset ()
	The Reset Method is used reset a latched Alarm instance. More...
virtual StatusCode	Silence ()
	The Silence Method is used silence a specific Alarm instance. More...
virtual StatusCode	Activate ()
	Activates an alarm More...
virtual StatusCode	Inactivate ()
	Inactivates an alarm More...
virtual StatusCode	Activate (RequestContext context, bool active)
	Activates or inactivates an alarm More...
override StatusCode	Acknowledge (byte[] eventId, LocalizedText comment, string clientUserId)
	Acknowledges an Event Notification for a Condition instance state where AckedState was set to FALSE. 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...
override void	UpdateRetain ()
	Update the retain bit. More...
override void	ActivateModel (RequestContext context)
	Activates the model. 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 (byte[] eventId, LocalizedText comment, string clientUserId)
	Confirms an Event Notification for a Condition instance state where ConfirmedState 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 ()
	Sets the AckedState to unacknowledged. More...
virtual void	ResetAcked (RequestContext context)
	Sets the AckedState to unacknowledged. More...
virtual void	ResetConfirmed ()
	Sets the state to 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
void	RaiseConditionChangedEvent (ConditionModel model)
	Emits a new condition changed event. More...
virtual StatusCode	Enable ()
	Changes a Condition instance to the enabled state. More...
virtual StatusCode	Enable (RequestContext context)
	Changes a Condition instance to the enabled state. More...
virtual StatusCode	Disable ()
	Changes a Condition instance to the disabled state. More...
virtual StatusCode	Disable (RequestContext context)
	Changes a Condition instance to the disabled state. More...
virtual StatusCode	AddComment (byte[] eventId, LocalizedText comment, string clientUserId)
	Applies a comment to a specific state of a Condition instance. More...
virtual StatusCode	AddComment (RequestContext context, byte[] eventId, LocalizedText comment)
	Applies a comment to a specific state of a Condition instance. More...
TransitionRaiser	MergeTransitions ()
	Merges transitions. More...
TransitionRaiser	NewTransition ()
virtual void	DeactivateModel ()
	Deactivates the model. 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	SetRolePermissions (RolePermissionTypeCollection rolePermissions, BaseNodeManager nodeManager)
	Sets the RolePermissions to an event. Is used to restrict the receiving of the events to certain roles. More...
void	SetRolePermissionsAndAccessRestriction (Node sourceNode, BaseNodeManager nodeManager)
	Sets the RolePermissions and AccessRestiriction to an event. Is used to restrict the receiving of the events to certain users. 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...
StatusCode	GetStatusCode (string propertyName)
	Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned. Parameters propertyName The property name. Returns The status code of the property.
void	SetStatusCode (string propertyName, StatusCode statusCode)
	Sets the status code of the given property. More...
Public Member Functions inherited from UnifiedAutomation.UaServer.ICondition
GenericEvent	CreateEvent (FilterManager manager, bool autoGenerateEventIdAndTime)
	Creates an generic event for the condition. More...

Properties
NodeId	BaseSetpointNode [get, set]
	Gets or sets the BaseSetpointNode More...
NodeId	SetpointNode [get, set]
	Provides the NodeId of the set point used in the deviation calculation. More...
Properties inherited from UnifiedAutomation.UaServer.NonExclusiveLimitAlarmModel
new TwoStateVariableModel	ActiveState [get, set]
	Gets or sets the ActiveState More...
TwoStateVariableModel	HighHighState [get, set]
	Represents one of the four non-exclusive states. More...
TwoStateVariableModel	HighState [get, set]
	Represents one of the four non-exclusive states. More...
TwoStateVariableModel	LowLowState [get, set]
	Represents one of the four non-exclusive states. More...
TwoStateVariableModel	LowState [get, set]
	Represents one of the four non-exclusive states. More...
Properties inherited from UnifiedAutomation.UaServer.LimitAlarmModel
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	HighDeadband [get, set]
	Gets or sets the HighDeadband More...
double	HighHighDeadband [get, set]
	Gets or sets the HighHighDeadband More...
double	HighHighLimit [get, set]
	Gets or sets the HighHighLimit More...
double	HighLimit [get, set]
	Gets or sets the HighLimit More...
double	LowDeadband [get, set]
	Gets or sets the LowDeadband More...
double	LowLimit [get, set]
	Gets or sets the LowLimit More...
double	LowLowDeadband [get, set]
	Gets or sets the LowLowDeadband More...
double	LowLowLimit [get, set]
	Gets or sets the LowLowLimit More...
ushort	SeverityHigh [get, set]
	Gets or sets the SeverityHigh More...
ushort	SeverityHighHigh [get, set]
	Gets or sets the SeverityHighHigh More...
ushort	SeverityLow [get, set]
	Gets or sets the SeverityLow More...
ushort	SeverityLowLow [get, set]
	Gets or sets the SeverityLowLow More...
Properties inherited from UnifiedAutomation.UaServer.AlarmConditionModel
AutoAcknowledgeMode	AutoAcknowledgeMode [get, set]
	The auto-acknowledge mode. More...
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
bool	IsAckedStateIgnored [get, set]
	Ignores the AckedState in the ConditionModel.Retain calculation. More...
ConfirmedStateResetMode	ConfirmedStateResetMode [get, set]
	Gets or sets the mode when to reset the confirmed state. More...
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
bool	IsInitialized [get, set]
	Gets or sets if the condition is initialized. More...
uint	TransitionCount [get]
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...
new NodeId	ConditionClassId [get, set]
	Specifies in which domain this Condition is used. More...
new LocalizedText	ConditionClassName [get, set]
string	ConditionName [get, set]
	Identifies the Condition instance that the Event originated from. 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...
NodeId	ConditionClassId [get, set]
	Specifies in which domain this Condition is used. More...
LocalizedText	ConditionClassName [get, set]
NodeId	ConditionSubClassId [get, set]
	ConditionSubClassId specifies additional class[es] that apply to the Event. More...
LocalizedText	ConditionSubClassName [get, set]
INodeAccessInfo	NodeAccessInfo [get, set]
	Using a NodeAccessInfo can restrict the access of an event to single scopes. More...
AccessRestrictionType	AccessRestriction [get, set]
	Using the AcccessRestrictions accessing the events can be restricted for users having a secure connection. More...
IRolePermissions	RolePermissions [get, set]
	Using the RolePermissions accessing the events can be restricted for users having one of the configured roles. 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...
Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool	HasStatusCodes [get]
	true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
Properties inherited from UnifiedAutomation.UaServer.ICondition
bool	Retain [get]
	The retain state. See Part 9: Alarms and Conditions More...
NodeId	SourceNode [get]
	The source node. See Part 9: Alarms and Conditions More...

Additional Inherited Members
Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool	HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
Protected Member Functions inherited from UnifiedAutomation.UaServer.AlarmConditionModel
override void	Initialize ()
	Called when the model is activated for the first time.
Protected Member Functions inherited from UnifiedAutomation.UaServer.ConditionModel
void	RaiseTransition ()
	Ends a merged transitions. More...
Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void	RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
	Raises an property change event. More...
void	RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
	Called when the value of a property is supposed to be changed. More...
bool	SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
	Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
Events inherited from UnifiedAutomation.UaServer.ConditionModel
EventHandler< ConditionModel >	ConditionChanged
	Occurs when the condition changed in a way that a new UA event needs to be emitted. More...
Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler	PropertyChanged
	Occurs when a property value changes. More...
EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged
Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The property change request event. More...
Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged
	Occurs if the status code of a property was changed. More...

Detailed Description

A special level Alarm utilized with one or more non-exclusive states.

For example if a set point had a value of 10 and the high deviation Alarm limit were set for 2 and the low deviation Alarm limit had a value of -1 then the low sub state is entered if the process value dropped to below 9; the high sub state is entered if the process value became larger than 12. If the set point were changed to 11 then the new deviation values would be 10 and 13 respectively.

If for example both the High and HighHigh states need to be maintained as active at the same time this AlarmType should be used. The NonExclusiveDeviationAlarmType is based on the NonExclusiveLimitAlarmType.

A deviation Alarm is commonly used to report an excess deviation between a desired set point level of a process value and an actual measurement of that value. The deviation Alarm becomes active when the deviation exceeds or drops below a defined limit.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.NonExclusiveDeviationAlarmModel

(

)

Initializes a new instance of the NonExclusiveDeviationAlarmModel class.

UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.NonExclusiveDeviationAlarmModel

(

NonExclusiveDeviationAlarmModel

template

)

Initializes a new instance of the NonExclusiveDeviationAlarmModel class.

Parameters

template

The template.

Member Function Documentation

void UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.Evaluate	(	double	value,
		double	setpoint
	)

Evaluates the given value.

This method will adjust the limit states NonExclusiveLimitAlarmModel.HighHighState, NonExclusiveLimitAlarmModel.HighState, NonExclusiveLimitAlarmModel.LowState and NonExclusiveLimitAlarmModel.LowLowState and the active state. Should there be a change in state the ConditionModel.ConditionChanged event will be raised.

Parameters

value	The input value.
setpoint	The setpoint.

override void UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.UpdateEvent ( GenericEvent  e )

virtual

Updates the event.

Parameters

e	The event to update.

Reimplemented from UnifiedAutomation.UaServer.NonExclusiveLimitAlarmModel.

Property Documentation

NodeId UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.BaseSetpointNode

getset

Gets or sets the BaseSetpointNode

NodeId UnifiedAutomation.UaServer.NonExclusiveDeviationAlarmModel.SetpointNode

getset

Provides the NodeId of the set point used in the deviation calculation.

If this Variable is not in the AddressSpace, a Null NodeId shall be provided.

---

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

• D:/work/uasdknet_master/src/UaServer/Controllers/Conditions/NonExclusiveDeviationAlarmModel.cs
• D:/work/uasdknet_master/src/UaServer/Models/UaBaseClasses.cs