UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.AlarmConditionModel Class Reference

More...

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...
 
IAcknowledgeableConditionMethods AcknowledgeableConditionMethods [get, set]
 Gets or sets the AcknowledgeableCondition methods. 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

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

Property Documentation

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.ActiveState
getset

Gets or sets the ActiveState

The ActiveState

new TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.EnabledState
getset

Gets or sets the EnabledState

The EnabledState

NodeId UnifiedAutomation.UaServer.AlarmConditionModel.InputNode
getset

Gets or sets the InputNode

The InputNode

double UnifiedAutomation.UaServer.AlarmConditionModel.MaxTimeShelved
getset

Gets or sets the MaxTimeShelved

The MaxTimeShelved

ShelvedStateMachineModel UnifiedAutomation.UaServer.AlarmConditionModel.ShelvingState
getset

Gets or sets the ShelvingState

The ShelvingState

bool UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedOrShelved
getset

Gets or sets the SuppressedOrShelved

The SuppressedOrShelved

TwoStateVariableModel UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedState
getset

Gets or sets the SuppressedState

The SuppressedState


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