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

Inherits UnifiedAutomation.UaServer.DiscreteItemModel.

Inherited by UnifiedAutomation.UaServer.MultiStateDiscreteModel< T >.

Public Member Functions

 MultiStateDiscreteModel ()
 Initializes a new instance of the MultiStateDiscreteModel class. More...
 
 MultiStateDiscreteModel (MultiStateDiscreteModel template)
 Initializes a new instance of the MultiStateDiscreteModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.DiscreteItemModel
 DiscreteItemModel ()
 Initializes a new instance of the DiscreteItemModel class. More...
 
 DiscreteItemModel (DiscreteItemModel template)
 Initializes a new instance of the DiscreteItemModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.DataItemModel
 DataItemModel ()
 Initializes a new instance of the DataItemModel class. More...
 
 DataItemModel (DataItemModel template)
 Initializes a new instance of the DataItemModel 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 object Value [get, set]
 Gets or sets the value. More...
 
LocalizedText[] EnumStrings [get, set]
 Gets or sets the EnumStrings More...
 

Detailed Description

This VariableType defines the general characteristics of a DiscreteItem that can have more than two states. The value of the DiscreteItem is delivered as UInteger but the EnumStrings Property defined by the MultiStateDiscreteType provides display strings for every possible state value.

EnumStrings is a string lookup table corresponding to sequential numeric values (0, 1, 2, etc.). Example:"OPEN""CLOSE""IN TRANSIT" etc. Here the string"OPEN" corresponds to 0,"CLOSE" to 1 and"IN TRANSIT" to 2.

If the item contains an array then this lookup table shall apply to all elements in the array.

The EnumStrings Property is also used for Enumeration DataTypes.

The StatusCode delivered with the value also contains an informational bit called SemanticsChanged. Servers that implement Data Access shall set this Bit in notifications if the EnumStrings (changes can cause misinterpretation by users or (scripting) programs) Property is changed. Clients that use any of these Properties should re-read them before they process the data value.

In addition a server can send SemanticChangeEvents if the value of the Property EnumStrings is changed. To indicate this capability, the SemanticChange flag must be set in the AccessLevel and UserAccessLevel attributes of this variable.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.MultiStateDiscreteModel.MultiStateDiscreteModel ( )
inline

Initializes a new instance of the MultiStateDiscreteModel class.

UnifiedAutomation.UaServer.MultiStateDiscreteModel.MultiStateDiscreteModel ( MultiStateDiscreteModel  template)
inline

Initializes a new instance of the MultiStateDiscreteModel class.

Parameters
templateThe template.

Property Documentation

LocalizedText [] UnifiedAutomation.UaServer.MultiStateDiscreteModel.EnumStrings
getset

Gets or sets the EnumStrings

EnumStrings is a string lookup table corresponding to sequential numeric values of the variable (0, 1, 2, etc.). Example:"OPEN""CLOSE""IN TRANSIT" etc. Here the string"OPEN" corresponds to 0,"CLOSE" to 1 and"IN TRANSIT" to 2.

new object UnifiedAutomation.UaServer.MultiStateDiscreteModel.Value
getset

Gets or sets the value.


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