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

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
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 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 ( )

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

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

inlinevirtual

Dispatches the method.

Parameters

context	The context.
methodHandle	The method handle.
inputArguments	The input arguments.
inputArgumentResults	The input argument results.
outputArguments	The output arguments.

Returns

Reimplemented from UnifiedAutomation.UaServer.AcknowledgeableConditionModel.

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

inline

Gets the method dispatcher.

Parameters

context	The context.
objectId	The object id.
methodId	The method id.

Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

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

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

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:

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