.NET Based OPC UA Client/Server SDK  3.3.0.530
UnifiedAutomation.UaServer.MultiStateValueDiscreteModel Class Reference

This VariableType defines the general characteristics of a DiscreteItem that can have more than two states and where the state values (the enumeration) do not consist of consecutive numeric values (may have gaps) or where the enumeration is not zero-based. More...

Inherits UnifiedAutomation.UaServer.DiscreteItemModel.

Inherited by UnifiedAutomation.UaServer.MultiStateDictionaryEntryDiscreteBaseModel, and UnifiedAutomation.UaServer.MultiStateValueDiscreteModel< T >.

Public Member Functions

 MultiStateValueDiscreteModel ()
 Initializes a new instance of the MultiStateValueDiscreteModel class. More...
 
 MultiStateValueDiscreteModel (MultiStateValueDiscreteModel template, DummyArgument dummy=null)
 Initializes a new instance of the MultiStateValueDiscreteModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.DiscreteItemModel
 DiscreteItemModel ()
 Initializes a new instance of the DiscreteItemModel class. More...
 
 DiscreteItemModel (DiscreteItemModel template, DummyArgument dummy=null)
 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, DummyArgument dummy=null)
 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, DummyArgument dummy=null)
 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, DummyArgument dummy=null)
 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...
 
StatusCode GetStatusCode (string propertyName)
 Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.
Parameters
propertyNameThe property name.
Returns
The status code of the property.

 
void SetStatusCode (string propertyName, StatusCode statusCode)
 Sets the status code of the given property. More...
 

Properties

EnumValueType[] EnumValues [get, set]
 An array of EnumValueType where each entry of the array represents one enumeration value with its integer notation, a human-readable representation, and help information. More...
 
LocalizedText ValueAsText [get, set]
 Provides the localized text representation of the enumeration value. More...
 
- Properties inherited from UnifiedAutomation.UaServer.DataItemModel
string Definition [get, set]
 A vendor-specific, human readable string that specifies how the value of this DataItem is calculated. More...
 
double ValuePrecision [get, set]
 Specifies the maximum precision that the server can maintain for the item based on restrictions in the target environment. 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...
 
- Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool HasStatusCodes [get]
 true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
 

Additional Inherited Members

- Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
 
- Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
 Raises an property change event. More...
 
void RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
 Called when the value of a property is supposed to be changed. More...
 
bool SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
 Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
 
- Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
 
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 
- Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The property change request event. More...
 
- Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 Occurs if the status code of a property was changed. More...
 

Detailed Description

This VariableType defines the general characteristics of a DiscreteItem that can have more than two states and where the state values (the enumeration) do not consist of consecutive numeric values (may have gaps) or where the enumeration is not zero-based.

The MultiStateValueDiscreteType derives from the DiscreteItemType. MultiStateValueDiscrete Variables can have any numeric Data Type; this includes signed and unsigned integers from 8 to 64 Bit length.

The numeric representation of the current enumeration value is provided via the Value Attribute of the MultiStateValueDiscrete Variable.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.MultiStateValueDiscreteModel.MultiStateValueDiscreteModel ( )

Initializes a new instance of the MultiStateValueDiscreteModel class.

UnifiedAutomation.UaServer.MultiStateValueDiscreteModel.MultiStateValueDiscreteModel ( MultiStateValueDiscreteModel  template,
DummyArgument  dummy = null 
)

Initializes a new instance of the MultiStateValueDiscreteModel class.

Parameters
templateThe template.
dummyDummy argument to enable writing own constructors that are called by the generated code.

Property Documentation

EnumValueType [] UnifiedAutomation.UaServer.MultiStateValueDiscreteModel.EnumValues
getset

An array of EnumValueType where each entry of the array represents one enumeration value with its integer notation, a human-readable representation, and help information.

This represents enumerations with integers that are not zero-based or have gaps (e.g. 1, 2, 4, 8, 16). See UnifiedAutomation.UaBase.EnumValueType for the definition of this type. MultiStateValueDiscrete Variables expose the current integer notation in their Value Attribute. Clients will often read the EnumValues Property in advance and cache it to look up a name or help whenever they receive the numeric representation.

LocalizedText UnifiedAutomation.UaServer.MultiStateValueDiscreteModel.ValueAsText
getset

Provides the localized text representation of the enumeration value.

It can be used by Clients only interested in displaying the text to subscribe to the Property instead of the Value Attribute.


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