.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.AlarmConditionModel Class Reference

An abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState. More...

Inherits UnifiedAutomation.UaServer.AcknowledgeableConditionModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Inherited by UnifiedAutomation.UaServer.DiscrepancyAlarmModel, UnifiedAutomation.UaServer.DiscreteAlarmModel, and UnifiedAutomation.UaServer.LimitAlarmModel.

Public Member Functions

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 void UpdateEvent (GenericEvent e)
 Updates the event. 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
propertyNameThe 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...
 

Protected Member Functions

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...
 

Properties

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
 
- Events inherited from UnifiedAutomation.UaServer.ConditionModel
EventHandler< ConditionModelConditionChanged
 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

An abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState.

The AlarmConditionType inherits all Properties of the AcknowledgeableConditionType. The following states are substates of the TRUE EnabledState.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AlarmConditionModel.AlarmConditionModel ( )

Initializes a new instance of the AlarmConditionModel class.

UnifiedAutomation.UaServer.AlarmConditionModel.AlarmConditionModel ( AlarmConditionModel  template)

Initializes a new instance of the AlarmConditionModel class.

Parameters
templateThe template.

Member Function Documentation

override StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Acknowledge ( byte[]  eventId,
LocalizedText  comment,
string  clientUserId 
)
virtual

Acknowledges an Event Notification for a Condition instance state where AckedState was set to FALSE.

If the alarm has a SilenceState, it will be set to silenced.

Parameters
eventIdEventId identifying a particular Event Notification. Only Event Notifications where AckedState/Id was FALSE can be acknowledged.
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Activate ( )
virtual

Activates an alarm

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Activate ( RequestContext  context,
bool  active 
)
virtual

Activates or inactivates an alarm

override void UnifiedAutomation.UaServer.AlarmConditionModel.ActivateModel ( RequestContext  context)
virtual

Activates the model.

If present this method will set the ShelvedStateMachineModel.ParentAlarm property of the ShelvingState instance.

Parameters
context

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

override StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.DispatchMethod ( RequestContext  context,
MethodHandle  methodHandle,
IList< Variant inputArguments,
List< StatusCode inputArgumentResults,
List< Variant outputArguments 
)
virtual

Dispatches the method.

Parameters
contextThe context.
methodHandleThe method handle.
inputArgumentsThe input arguments.
inputArgumentResultsThe input argument results.
outputArgumentsThe output arguments.
Returns

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

override CallMethodEventHandler UnifiedAutomation.UaServer.AlarmConditionModel.GetMethodDispatcher ( RequestContext  context,
NodeId  objectId,
NodeId  methodId 
)

Gets the method dispatcher.

Parameters
contextThe context.
objectIdThe object id.
methodIdThe method id.
Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Inactivate ( )
virtual

Inactivates an alarm

StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.OneShotShelve ( LocalizedText  comment,
string  clientUserId 
)

Shelves an alarm.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.OneShotShelve ( )

Shelves an alarm.

StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.OneShotShelve ( RequestContext  context)

Shelves an alarm.

Parameters
contextUnused parameter.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.PlaceInService ( LocalizedText  comment,
string  clientUserId 
)
virtual

Puts an alarm in service.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.PlaceInService ( )
virtual

Puts an alarm in service.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.RemoveFromService ( LocalizedText  comment,
string  clientUserId 
)
virtual

Puts an alarm out of service.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.RemoveFromService ( )
virtual

Puts an alarm out of service.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Reset ( LocalizedText  comment,
string  clientUserId 
)
virtual

The Reset Method is used reset a latched Alarm instance.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Reset ( )
virtual

The Reset Method is used reset a latched Alarm instance.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Silence ( )
virtual

The Silence Method is used silence a specific Alarm instance.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Suppress ( LocalizedText  comment,
string  clientUserId 
)
virtual

Suppresses an alarm.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Suppress ( )
virtual

Suppress an alarm.

virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Suppress ( RequestContext  context,
bool  suppress 
)
virtual

Suppress an alarm.

StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.TimedShelve ( LocalizedText  comment,
string  clientUserId 
)

Shelves an alarm for a defined time period.

The method takes only care on the state changes. The unshelving will not happen automatically.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.TimedShelve ( )

Shelves an alarm for a defined time period.

StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.TimedShelve ( RequestContext  context,
double  shelvingTime 
)

Shelves an alarm for a defined time period.

Parameters
contextUnused parameter.
shelvingTimeUnused parameter.
StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Unshelve ( LocalizedText  comment,
string  clientUserId 
)

Unshelves an alarm.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Unshelve ( )

Unshelves an alarm.

StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Unshelve ( RequestContext  context)

Unshelves an alarm.

Parameters
contextUnused parameter.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Unsuppress ( LocalizedText  comment,
string  clientUserId 
)
virtual

Unsuppresses an alarm.

Parameters
commentA localized text to be applied to the Condition.
clientUserIdThe client user id.
virtual StatusCode UnifiedAutomation.UaServer.AlarmConditionModel.Unsuppress ( )
virtual

Unsuppress an alarm.

virtual void UnifiedAutomation.UaServer.AlarmConditionModel.UpdateActiveEffectiveDisplayName ( )
virtual

Updates the effective display name for the active state.

Reimplemented in UnifiedAutomation.UaServer.ExclusiveLimitAlarmModel.

override void UnifiedAutomation.UaServer.AlarmConditionModel.UpdateEnabledEffectiveDisplayName ( )
virtual

Updates the effect display name for the enabled state.

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

override void UnifiedAutomation.UaServer.AlarmConditionModel.UpdateRetain ( )
virtual

Property Documentation

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.ActiveState
getset

ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.

When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.

LocaleId FALSE State Name TRUE State Name
en Inactive Active
de Inaktiv Aktiv
fr Inactive Active
bool UnifiedAutomation.UaServer.AlarmConditionModel.AudibleEnabled
getset

Gets or sets the AudibleEnabled

byte [] UnifiedAutomation.UaServer.AlarmConditionModel.AudibleSound
getset

Gets or sets the AudibleSound

AutoAcknowledgeMode UnifiedAutomation.UaServer.AlarmConditionModel.AutoAcknowledgeMode
getset

The auto-acknowledge mode.

new TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.EnabledState
getset

Gets or sets the EnabledState

AlarmGroupModel UnifiedAutomation.UaServer.AlarmConditionModel.FirstInGroup
getset

Gets or sets the FirstInGroup

bool UnifiedAutomation.UaServer.AlarmConditionModel.FirstInGroupFlag
getset

Gets or sets the FirstInGroupFlag

NodeId UnifiedAutomation.UaServer.AlarmConditionModel.InputNode
getset

Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.

If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.LatchedState
getset

Gets or sets the LatchedState

double UnifiedAutomation.UaServer.AlarmConditionModel.MaxTimeShelved
getset

Optional Property used to set the maximum time that an Alarm Condition may be shelved.

The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.

UnifiedAutomation.UaServer.ShelvedStateMachineModel UnifiedAutomation.UaServer.IShelvedStateMachineMethods.TimedShelve UnifiedAutomation.UaServer.IShelvedStateMachineMethods.OneShotShelve

double UnifiedAutomation.UaServer.AlarmConditionModel.OffDelay
getset

Gets or sets the OffDelay

double UnifiedAutomation.UaServer.AlarmConditionModel.OnDelay
getset

Gets or sets the OnDelay

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.OutOfServiceState
getset

Gets or sets the OutOfServiceState

short UnifiedAutomation.UaServer.AlarmConditionModel.ReAlarmRepeatCount
getset

Gets or sets the ReAlarmRepeatCount

double UnifiedAutomation.UaServer.AlarmConditionModel.ReAlarmTime
getset

Gets or sets the ReAlarmTime

ShelvedStateMachineModel UnifiedAutomation.UaServer.AlarmConditionModel.ShelvingState
getset

Suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user.

It is quite often used to block nuisance Alarms.

UnifiedAutomation.UaServer.ShelvedStateMachineModel

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.SilenceState
getset

Gets or sets the SilenceState

bool UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedOrShelved
getset

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.

When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.

UnifiedAutomation.UaServer.ShelvedStateMachineModel

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedState
getset

Used internally by a Server to automatically suppress Alarms due to system specific reasons.

For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.

LocaleId FALSE State Name TRUE State Name
en Unsuppressed Suppressed
de Nicht unterdrückt Unterdrückt
fr Présent Supprimé

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