.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaServer.TwoStateVariableModel Class Reference

Inherits UnifiedAutomation.UaServer.StateVariableModel.

Public Member Functions

 TwoStateVariableModel ()
 Initializes a new instance of the TwoStateVariableModel class. More...
 
 TwoStateVariableModel (TwoStateVariableModel template)
 Initializes a new instance of the TwoStateVariableModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.StateVariableModel
 StateVariableModel ()
 Initializes a new instance of the StateVariableModel class. More...
 
 StateVariableModel (StateVariableModel template)
 Initializes a new instance of the StateVariableModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseDataVariableModel
 BaseDataVariableModel ()
 Initializes a new instance of the BaseDataVariableModel class. More...
 
 BaseDataVariableModel (BaseDataVariableModel template)
 Initializes a new instance of the BaseDataVariableModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseVariableModel
 BaseVariableModel ()
 Initializes a new instance of the BaseVariableModel class. More...
 
 BaseVariableModel (BaseVariableModel template)
 Initializes a new instance of the BaseVariableModel class. 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

DateTime EffectiveTransitionTime [get, set]
 EffectiveTransitionTime specifies the time when the current state or one of its substates was entered. More...
 
LocalizedText FalseState [get, set]
 TrueState and FalseState contain the localized string for the TwoStateVariable value when its Id Property has the value TRUE or FALSE, respectively. More...
 
new bool Id [get, set]
 The Property Id shall be the current state, i.e. either TRUE or FALSE. More...
 
DateTime TransitionTime [get, set]
 TransitionTime specifies the time when the current state was entered. More...
 
LocalizedText TrueState [get, set]
 TrueState and FalseState contain the localized string for the TwoStateVariable value when its Id Property has the value TRUE or FALSE, respectively. More...
 
- Properties inherited from UnifiedAutomation.UaServer.StateVariableModel
new LocalizedText Value [get, set]
 Gets or sets the value. More...
 
LocalizedText EffectiveDisplayName [get, set]
 Contains a human readable name for the current state of the state machine after taking the state of any SubStateMachines in account. More...
 
object Id [get, set]
 A name which uniquely identifies the current state within the StateMachineType. More...
 
QualifiedName Name [get, set]
 A QualifiedName which uniquely identifies the current state within the StateMachineType. More...
 
uint Number [get, set]
 An integer which uniquely identifies the current state within the StateMachineType. More...
 
- Properties inherited from UnifiedAutomation.UaServer.BaseVariableModel
object Value [get, set]
 Gets or sets the value. 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

Most states defined in the OPC UA Specification are simple – i.e. they are either TRUE or FALSE. The TwoStateVariableType is introduced specifically for this use case. More complex states are modelled by using a StateMachineType. The TwoStateVariableType is derived from the StateVariableType. The Value Attribute of a TwoStateVariable contains the current state as a human readable name. The EnabledState for example, might contain the name “Enabled” when TRUE and “Disabled” when FALSE.

The optional Property EffectiveDisplayName from the StateVariableType is used if a state has substates. It contains a human readable name for the current state after taking the state of any SubStateMachines in account. As an example, the EffectiveDisplayName of the EnabledState could contain “Active/HighHigh” to specify that the Condition is active and has exceeded the HighHigh limit.

A HasTrueSubState Reference is used to indicate that the TRUE state has substates.

A HasFalseSubState Reference is used to indicate that the FALSE state has substates.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.TwoStateVariableModel.TwoStateVariableModel ( )
inline

Initializes a new instance of the TwoStateVariableModel class.

UnifiedAutomation.UaServer.TwoStateVariableModel.TwoStateVariableModel ( TwoStateVariableModel  template)
inline

Initializes a new instance of the TwoStateVariableModel class.

Parameters
templateThe template.

Property Documentation

DateTime UnifiedAutomation.UaServer.TwoStateVariableModel.EffectiveTransitionTime
getset

EffectiveTransitionTime specifies the time when the current state or one of its substates was entered.

If, for example, a LevelAlarm is active and – while active – switches several times between High and HighHigh, then the TransitionTime stays at the point in time where the Alarm became active whereas the EffectiveTransitionTime changes with each shift of a substate.

LocalizedText UnifiedAutomation.UaServer.TwoStateVariableModel.FalseState
getset

TrueState and FalseState contain the localized string for the TwoStateVariable value when its Id Property has the value TRUE or FALSE, respectively.

Since the two Properties provide metadata for the Type, Servers may not allow these Properties to be selected in the Event filter for a monitored item. Clients can use the Read Service to get the information from the specific ConditionType.

new bool UnifiedAutomation.UaServer.TwoStateVariableModel.Id
getset

The Property Id shall be the current state, i.e. either TRUE or FALSE.

Id is inherited from the StateVariableType and overridden to reflect the required DataType (Boolean).

DateTime UnifiedAutomation.UaServer.TwoStateVariableModel.TransitionTime
getset

TransitionTime specifies the time when the current state was entered.

LocalizedText UnifiedAutomation.UaServer.TwoStateVariableModel.TrueState
getset

TrueState and FalseState contain the localized string for the TwoStateVariable value when its Id Property has the value TRUE or FALSE, respectively.

Since the two Properties provide meta-data for the Type, Servers may not allow these Properties to be selected in the Event filter for a monitored item. Clients can use the Read Service to get the information from the specific ConditionType.


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