UA Bundle SDK .NET
2.3.1.334
|
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] |
Gets or sets the EffectiveTransitionTime More... | |
LocalizedText | FalseState [get, set] |
Gets or sets the FalseState More... | |
new bool | Id [get, set] |
Gets or sets the Id More... | |
DateTime | TransitionTime [get, set] |
Gets or sets the TransitionTime More... | |
LocalizedText | TrueState [get, set] |
Gets or sets the TrueState More... | |
Properties inherited from UnifiedAutomation.UaServer.StateVariableModel | |
new LocalizedText | Value [get, set] |
Gets or sets the value. More... | |
LocalizedText | EffectiveDisplayName [get, set] |
Gets or sets the EffectiveDisplayName More... | |
object | Id [get, set] |
Gets or sets the Id More... | |
QualifiedName | Name [get, set] |
Gets or sets the Name More... | |
uint | Number [get, set] |
Gets or sets the Number More... | |
Properties inherited from UnifiedAutomation.UaServer.BaseDataVariableModel | |
new object | Value [get, set] |
Gets or sets the value. 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... | |
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.
EnabledState defines the optional Properties TransitionTime, EffectiveTransitionTime, TrueState, and FalseState. It inherits the Properties Id and EffectiveDisplayName from StateVariableType.
Id is inherited from the StateVariableType and overridden to reflect the required DataType (Boolean). The value shall be the current state, i.e. either TRUE or FALSE.
TransitionTime specifies the time when the current state was entered.
EffectiveTransitionTime specifies the time when the current state or one of its sub states 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 sub state.
The optional Property EffectiveDisplayName from the StateVariableType is used if a state has sub states. 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.
Other optional Properties of the StateVariableType have no defined meaning for TwoStateVariables.
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.
A HasTrueSubState Reference is used to indicate that the TRUE state has sub states.
A HasFalseSubState Reference is used to indicate that the FALSE state has sub states.
|
inline |
Initializes a new instance of the TwoStateVariableModel class.
|
inline |
Initializes a new instance of the TwoStateVariableModel class.
template | The template. |
|
getset |
Gets or sets the EffectiveTransitionTime
EffectiveTransitionTime specifies the time when the current state or one of its sub states 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 sub state.
|
getset |
Gets or sets the FalseState
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.
|
getset |
Gets or sets the Id
The Property Id shall be the current state, i.e. either TRUE or FALSE.
|
getset |
Gets or sets the TransitionTime
TransitionTime specifies the time when the current state was entered.
|
getset |
Gets or sets the TrueState
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.