.NET Based OPC UA Client/Server SDK  3.0.5.474
UnifiedAutomation.UaServer.AnalogItemModel Class Reference

Specifies the units for the AnalogItem value (e.g., DEGC, hertz, seconds). More...

Inherits UnifiedAutomation.UaServer.BaseAnalogModel.

Inherited by UnifiedAutomation.UaServer.AnalogItemModel< T >, and UnifiedAutomation.UaServer.AnalogUnitRangeModel.

Public Member Functions

 AnalogItemModel ()
 Initializes a new instance of the AnalogItemModel class. More...
 
 AnalogItemModel (AnalogItemModel template)
 Initializes a new instance of the AnalogItemModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseAnalogModel
 BaseAnalogModel ()
 Initializes a new instance of the BaseAnalogModel class. More...
 
 BaseAnalogModel (BaseAnalogModel template)
 Initializes a new instance of the BaseAnalogModel 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 Range EURange [get, set]
 Defines the value range that can be returned by the instrument. More...
 
- Properties inherited from UnifiedAutomation.UaServer.BaseAnalogModel
EUInformation EngineeringUnits [get, set]
 Gets or sets the EngineeringUnits More...
 
Range EURange [get, set]
 Gets or sets the EURange More...
 
Range InstrumentRange [get, set]
 Gets or sets the InstrumentRange 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...
 

Detailed Description

Specifies the units for the AnalogItem value (e.g., DEGC, hertz, seconds).

Understanding the units of a measurement value is essential for a uniform system. In an open system in particular where servers from different cultures might be used, it is essential to know what the units of measurement are. Based on such knowledge, values can be converted if necessary before being used. Therefore, although defined as optional, support of the EngineeringUnits Property is strongly advised.

To facilitate interoperability, OPC UA specifies how to apply the widely accepted “Codes for Units of Measurement (Recommendation No. 20)” published by the “United Nations Centre for Trade Facilitation and Electronic Business” (see UN/CEFACT). It uses and is based on the International System of Units (SI Units) but in addition provides a fixed code that can be used for automated evaluation. This recommendation has been accepted by many industries on a global basis.

The class UaEUInformation provides helper functions to create the unit information from a unitId provided as enumeration. The methods are UaEUInformation::fromUnitId and UaEUInformation::setEUInformation.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AnalogItemModel.AnalogItemModel ( )
inline

Initializes a new instance of the AnalogItemModel class.

UnifiedAutomation.UaServer.AnalogItemModel.AnalogItemModel ( AnalogItemModel  template)
inline

Initializes a new instance of the AnalogItemModel class.

Parameters
templateThe template.

Property Documentation

new Range UnifiedAutomation.UaServer.AnalogItemModel.EURange
getset

Defines the value range that can be returned by the instrument.

Although defined as optional, it is strongly recommended for Servers to support this Property. Without an InstrumentRange being provided, Clients will commonly assume the full range according to the DataType.


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