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

Inherits UnifiedAutomation.UaServer.DataItemModel.

Inherited by UnifiedAutomation.UaServer.AnalogItemModel< T >.

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.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...
 
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
new object Value [get, set]
 Gets or sets the value. More...
 
string Definition [get, set]
 Gets or sets the Definition More...
 
double ValuePrecision [get, set]
 Gets or sets the ValuePrecision 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

This VariableType defines the general characteristics of an AnalogItem. It defines the properties EURange, EngineeringUnits and InstrumentRange. The AnalogItemType derives from the DataItemType.

EURange defines the value range likely to be obtained in normal operation. It is intended for such use as automatically scaling a bar graph display. It is also used as base for the calculation of the PercentDeadband.

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

InstrumentRange defines the value range that can be returned by the instrument.

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 EURange (could change the behaviour of a Subscription if a PercentDeadband filter is used) or EngineeringUnits (could create problems if the client uses the value to perform calculations) Properties are 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 properties EURange and EngineeringUnits are 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.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

EUInformation UnifiedAutomation.UaServer.AnalogItemModel.EngineeringUnits
getset

Gets or sets the EngineeringUnits

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

Range UnifiedAutomation.UaServer.AnalogItemModel.EURange
getset

Gets or sets the EURange

EURange defines the value range likely to be obtained in normal operation. It is intended for such use as automatically scaling a bar graph display.

Sensor or instrument failure or deactivation can result in a returned item value which is actually outside of this range. Client software must be prepared to deal with this possibility. Similarly a client may attempt to write a value that is outside of this range back to the server. The exact behaviour (accept, reject, clamp, etc.) in this case is server-dependent. However, in general servers shall be prepared to handle this.

The EURange is also used as base for the calculation of the PercentDeadband.

Range UnifiedAutomation.UaServer.AnalogItemModel.InstrumentRange
getset

Gets or sets the InstrumentRange

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

new object UnifiedAutomation.UaServer.AnalogItemModel.Value
getset

Gets or sets the value.


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