Inherits UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

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

Public Member Functions
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 void	UpdateEvent (GenericEvent e)
	Updates the event. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.AcknowledgeableConditionModel
virtual StatusCode	Acknowledge (RequestContext context, byte[] eventId, LocalizedText comment)
	Acknowledges an alarm. More...

virtual StatusCode	Confirm (RequestContext context, byte[] eventId, LocalizedText comment)
	Confirms an alarm. 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...

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.ConditionModel
virtual StatusCode	Enable (RequestContext context)
	Enables the condition. More...

virtual StatusCode	Disable (RequestContext context)
	Disables the condition. More...

virtual StatusCode	AddComment (RequestContext context, byte[] eventId, LocalizedText comment)
	Adds a comment to the condition. 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 event id, time and receive time to the event. More...

virtual GenericEvent	CreateEvent (FilterManager manager)
	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
TwoStateVariableModel	ActiveState `[get, set]`
	Gets or sets the ActiveState More...

new TwoStateVariableModel	EnabledState `[get, set]`
	Gets or sets the EnabledState More...

NodeId	InputNode `[get, set]`
	Gets or sets the InputNode More...

double	MaxTimeShelved `[get, set]`
	Gets or sets the MaxTimeShelved More...

ShelvedStateMachineModel	ShelvingState `[get, set]`
	Gets or sets the ShelvingState More...

bool	SuppressedOrShelved `[get, set]`
	Gets or sets the SuppressedOrShelved More...

TwoStateVariableModel	SuppressedState `[get, set]`
	Gets or sets the SuppressedState More...

Properties inherited from UnifiedAutomation.UaServer.AcknowledgeableConditionModel
TwoStateVariableModel	AckedState `[get, set]`
	Gets or sets the AckedState More...

TwoStateVariableModel	ConfirmedState `[get, set]`
	Gets or sets the ConfirmedState More...

new TwoStateVariableModel	EnabledState `[get, set]`
	Gets or sets the EnabledState More...

Properties inherited from UnifiedAutomation.UaServer.ConditionModel
NodeId	BranchId `[get, set]`
	Gets or sets the BranchId More...

string	ClientUserId `[get, set]`
	Gets or sets the ClientUserId More...

ConditionVariableModel < LocalizedText >	Comment `[get, set]`
	Gets or sets the Comment More...

NodeId	ConditionClassId `[get, set]`
	Gets or sets the ConditionClassId More...

LocalizedText	ConditionClassName `[get, set]`
	Gets or sets the ConditionClassName More...

string	ConditionName `[get, set]`
	Gets or sets the ConditionName More...

TwoStateVariableModel	EnabledState `[get, set]`
	Gets or sets the EnabledState More...

ConditionVariableModel< ushort >	LastSeverity `[get, set]`
	Gets or sets the LastSeverity More...

ConditionVariableModel < StatusCode >	Quality `[get, set]`
	Gets or sets the Quality More...

bool	Retain `[get, set]`
	Gets or sets the Retain More...

IConditionMethods	ConditionMethods `[get, set]`
	Gets or sets the Condition methods. More...

Properties inherited from UnifiedAutomation.UaServer.BaseEventModel
NodeId	NodeId `[get, set]`
	Gets or sets the event id. More...

byte[]	EventId `[get, set]`
	Gets or sets the event id. More...

NodeId	EventType `[get, set]`
	Gets or sets the type of the event. More...

NodeId	SourceNode `[get, set]`
	Gets or sets the source node. More...

string	SourceName `[get, set]`
	Gets or sets the name of the source. More...

DateTime	Time `[get, set]`
	Gets or sets the time. More...

DateTime	ReceiveTime `[get, set]`
	Gets or sets the receive time. More...

TimeZoneDataType	LocalTime `[get, set]`
	Gets or sets the local time. More...

LocalizedText	Message `[get, set]`
	Gets or sets the message. More...

ushort	Severity `[get, set]`
	Gets or sets the severity. 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

The AlarmConditionType is 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 sub-states of the TRUE EnabledState.

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. See UnifiedAutomation.UaServer.AlarmConditionModel.ActiveState for more details.

The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. See UnifiedAutomation.UaServer.AlarmConditionModel.InputNode for more details.

SuppressedState is used internally by a Server to automatically suppress Alarms due to system specific reasons. See UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedState for more details.

ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance Alarms (see also UnifiedAutomation.UaServer.ShelvedStateMachineModel).

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. See UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedState for more details.

The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. See UnifiedAutomation.UaServer.AlarmConditionModel.MaxTimeShelved for more details.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AlarmConditionModel.AlarmConditionModel ( )

inline

Initializes a new instance of the AlarmConditionModel class.

UnifiedAutomation.UaServer.AlarmConditionModel.AlarmConditionModel ( AlarmConditionModel template )

inline

Initializes a new instance of the AlarmConditionModel class.

Parameters

template The template.

Member Function Documentation

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

inlinevirtual

Activates an alarm

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

inline

Shelves an alarm.

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

inlinevirtual

Suppresses an alarm.

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

inline

Shelves an alarm for the specified time.

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

inline

Unshelves an alarm.

virtual void UnifiedAutomation.UaServer.AlarmConditionModel.UpdateActiveEffectiveDisplayName ( )

inlinevirtual

Updates the effective display name for the active state.

Reimplemented in UnifiedAutomation.UaServer.ExclusiveLimitAlarmModel.

override void UnifiedAutomation.UaServer.AlarmConditionModel.UpdateEnabledEffectiveDisplayName ( )

inlinevirtual

Updates the effect display name for the enabled state.

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

Reimplemented in UnifiedAutomation.UaServer.ExclusiveLimitAlarmModel.

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

inlinevirtual

Updates the event.

Parameters

e	The event to update.

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

Property Documentation

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.ActiveState

getset

Gets or sets the ActiveState

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. Sub-Types of the AlarmConditionType will have sub-state 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

new TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.EnabledState

getset

Gets or sets the EnabledState

NodeId UnifiedAutomation.UaServer.AlarmConditionModel.InputNode

getset

Gets or sets the InputNode

The InputNode Property 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.

double UnifiedAutomation.UaServer.AlarmConditionModel.MaxTimeShelved

getset

Gets or sets the MaxTimeShelved

The optional Property MaxTimeShelved is 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

ShelvedStateMachineModel UnifiedAutomation.UaServer.AlarmConditionModel.ShelvingState

getset

Gets or sets the ShelvingState

ShelvingState 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

bool UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedOrShelved

getset

Gets or sets the SuppressedOrShelved

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

Gets or sets the SuppressedState

SuppressState is 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:

C:/work/uasdknet/src/UaServer/Controllers/ConditionModel.cs
C:/work/uasdknet/src/UaServer/Models/UaBaseClasses.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation