UnifiedAutomation.UaServer.OptionSetModel Class Reference

This VariableType is used to represent a bit mask. More...

Inherits UnifiedAutomation.UaServer.BaseDataVariableModel.

Inherited by UnifiedAutomation.UaServer.OptionSetModel< T >.

Public Member Functions
	OptionSetModel ()
	Initializes a new instance of the OptionSetModel class. More...
	OptionSetModel (OptionSetModel template)
	Initializes a new instance of the OptionSetModel 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
bool[]	BitMask [get, set]
	Provides the bit mask in an array of Booleans. More...
LocalizedText[]	OptionSetValues [get, set]
	Gets or sets the OptionSetValues 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

This VariableType is used to represent a bit mask.

Each array element of the OptionSetValues Property contains either the human-readable representation for the corresponding bit used in the option set or an empty LocalizedText for a bit that has no specific meaning. The order of the bits of the bit mask maps to a position of the array, i.e. the first bit (least significant bit) maps to the first entry in the array, etc.

The DataType of this VariableType shall be capable of representing a bit mask. It shall be either a numeric DataType representing a signed or unsigned integer, or a ByteString. For example, it can be the BitFieldMaskDataType.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.OptionSetModel.OptionSetModel ( )

inline

Initializes a new instance of the OptionSetModel class.

UnifiedAutomation.UaServer.OptionSetModel.OptionSetModel ( OptionSetModel  template )

inline

Initializes a new instance of the OptionSetModel class.

Parameters

template

The template.

Property Documentation

bool [] UnifiedAutomation.UaServer.OptionSetModel.BitMask

getset

Provides the bit mask in an array of Booleans.

This allows subscribing to individual entries of the bit mask. The order of the bits of the bit mask points to a position of the array, i.e. the first bit points to the first entry in the array, etc.

LocalizedText [] UnifiedAutomation.UaServer.OptionSetModel.OptionSetValues

getset

Gets or sets the OptionSetValues

---

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

• C:/work/uasdknet/src/UaServer/Models/UaBaseClasses.cs