Inherits UnifiedAutomation.UaServer.ConditionModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Inherited by UnifiedAutomation.UaServer.AlarmConditionModel.

Public Member Functions
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...

override void	UpdateEnabledEffectiveDisplayName ()
	Updates the effect display name for the enabled state. More...

	AcknowledgeableConditionModel ()
	Initializes a new instance of the AcknowledgeableConditionModel class. More...

	AcknowledgeableConditionModel (AcknowledgeableConditionModel template)
	Initializes a new instance of the AcknowledgeableConditionModel 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.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	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 AcknowledgeableConditionType extends the ConditionType by defining acknowledgement characteristics. It is an abstract type.

The AcknowledgeableConditionType inherits all Properties of the ConditionType.

AcknowledgeableConditions expose states to indicate whether a Condition has to be acknowledged or confirmed.

The Confirmed Acknowledge model is typically used to differentiate between acknowledging the presence of a Condition and having done something to address the Condition. For example an Operator receiving a motor high temperature Notification calls the Acknowledge Method to inform the Server that the high temperature has been observed. The Operator then takes some action such as lowering the load on the motor in order to reduce the temperature. The Operator then calls the Confirm Method to inform the Server that a corrective action has been taken.

AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. When the Condition instance is acknowledged the AckedState is set to TRUE. ConfirmedState indicates whether it requires confirmation. The two states are sub-states of the TRUE EnabledState. The EventId used in the Event Notification is considered the identifier of this state and has to be used when calling the Methods for acknowledgement or confirmation.

A Server may require that previous states be acknowledged. If the acknowledgement of a previous state is still open and a new state also requires acknowledgement, the Server shall create a branch of the Condition instance. In situations where state changes occur in short succession there can be multiple unacknowledged states and the Server has to maintain ConditionBranches for all previous unacknowledged states. These branches will be deleted after they have been acknowledged or if they reached their final state. Clients are expected to keep track of all ConditionBranches where AckedState is FALSE to allow acknowledgement of those. See also UnifiedAutomation.UaServer.ConditionModel for more information about ConditionBranches and the examples in Annex B.1. The handling of the AckedState and branches also applies to the ConfirmState.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AcknowledgeableConditionModel.AcknowledgeableConditionModel ( )

inline

Initializes a new instance of the AcknowledgeableConditionModel class.

UnifiedAutomation.UaServer.AcknowledgeableConditionModel.AcknowledgeableConditionModel ( AcknowledgeableConditionModel template )

inline

Initializes a new instance of the AcknowledgeableConditionModel class.

Parameters

template The template.

Member Function Documentation

virtual StatusCode UnifiedAutomation.UaServer.AcknowledgeableConditionModel.Acknowledge	(	RequestContext	context,
		byte[]	eventId,
		LocalizedText	comment
	)

inlinevirtual

Acknowledges an alarm.

virtual StatusCode UnifiedAutomation.UaServer.AcknowledgeableConditionModel.Confirm	(	RequestContext	context,
		byte[]	eventId,
		LocalizedText	comment
	)

inlinevirtual

Confirms an alarm.

override StatusCode UnifiedAutomation.UaServer.AcknowledgeableConditionModel.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.ConditionModel.

override CallMethodEventHandler UnifiedAutomation.UaServer.AcknowledgeableConditionModel.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.

virtual void UnifiedAutomation.UaServer.AcknowledgeableConditionModel.ResetAcked ( RequestContext context )

inlinevirtual

Sets the state to unacknownledged and unconfirmed.

override void UnifiedAutomation.UaServer.AcknowledgeableConditionModel.UpdateEnabledEffectiveDisplayName ( )

inlinevirtual

Updates the effect display name for the enabled state.

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

Reimplemented in UnifiedAutomation.UaServer.ExclusiveLimitAlarmModel, and UnifiedAutomation.UaServer.AlarmConditionModel.

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

inlinevirtual

Updates the event.

Parameters

e	The event to update.

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

Property Documentation

TwoStateVariableModel UnifiedAutomation.UaServer.AcknowledgeableConditionModel.AckedState

getset

Gets or sets the AckedState

AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. When the Condition instance is acknowledged the AckedState is set to TRUE. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Unacknowledged	Acknowledged
de	Unquittiert	Quittiert
fr	Non-acquitté	Acquitté

TwoStateVariableModel UnifiedAutomation.UaServer.AcknowledgeableConditionModel.ConfirmedState

getset

Gets or sets the ConfirmedState

ConfirmedState indicates whether the Condition requires confirmation. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Unconfirmed	Confirmed
de	Unbestätigt	Bestätigt
fr	Non-Confirmé	Confirmé

new TwoStateVariableModel UnifiedAutomation.UaServer.AcknowledgeableConditionModel.EnabledState

getset

Gets or sets the EnabledState

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