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

Inherits UnifiedAutomation.UaServer.BaseDataVariableModel.

Inherited by UnifiedAutomation.UaServer.FiniteStateVariableModel, and UnifiedAutomation.UaServer.TwoStateVariableModel.

Public Member Functions

 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

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

Detailed Description

The StateVariableType is the base VariableType for Variables that store the current state of a StateMachine as a human readable name.

It defines the mandatory Property Id as well as the optional properties Name, Number and EffectiveDisplayName.

Id is a name which uniquely identifies the current state within the StateMachineType. A subtype may restrict the DataType.

Name is a QualifiedName which uniquely identifies the current state within the StateMachineType.

Number is an integer which uniquely identifies the current state within the StateMachineType.

EffectiveDisplayName contains a human readable name for the current state of the state machine after taking the state of any SubStateMachines in account. There is no rule specified for which state or sub-state should be used. It is up to the Server and will depend on the semantics of the StateMachineType.

StateMachines produce Events which may include the current state of a StateMachine. In that case Servers shall provide all the optional Properties of the StateVariableType in the Event, even if they are not provided on the instances in the AddressSpace.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.StateVariableModel.StateVariableModel ( )
inline

Initializes a new instance of the StateVariableModel class.

UnifiedAutomation.UaServer.StateVariableModel.StateVariableModel ( StateVariableModel  template)
inline

Initializes a new instance of the StateVariableModel class.

Parameters
templateThe template.

Property Documentation

LocalizedText UnifiedAutomation.UaServer.StateVariableModel.EffectiveDisplayName
getset

Gets or sets the EffectiveDisplayName

EffectiveDisplayName contains a human readable name for the current state of the state machine after taking the state of any SubStateMachines in account. There is no rule specified for which state or sub-state should be used. It is up to the Server and will depend on the semantics of the StateMachineType.

object UnifiedAutomation.UaServer.StateVariableModel.Id
getset

Gets or sets the Id

Id is a name which uniquely identifies the current state within the StateMachineType. A subtype may restrict the DataType.

QualifiedName UnifiedAutomation.UaServer.StateVariableModel.Name
getset

Gets or sets the Name

Name is a QualifiedName which uniquely identifies the current state within the StateMachineType.

uint UnifiedAutomation.UaServer.StateVariableModel.Number
getset

Gets or sets the Number

Number is an integer which uniquely identifies the current state within the StateMachineType.

new LocalizedText UnifiedAutomation.UaServer.StateVariableModel.Value
getset

Gets or sets the value.


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