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

This VariableType defines the general characteristics of a DataItem. More...

Inherits UnifiedAutomation.UaServer.BaseDataVariableModel.

Inherited by UnifiedAutomation.UaServer.BaseAnalogModel, UnifiedAutomation.UaServer.DataItemModel< T >, and UnifiedAutomation.UaServer.DiscreteItemModel.

Public Member Functions

 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

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

All other DataItem Types derive from it. It defines the optional properties Definition and ValuePrecision. The DataItemType derives from the BaseDataVariableType.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.DataItemModel.DataItemModel ( )

Initializes a new instance of the DataItemModel class.

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

Initializes a new instance of the DataItemModel class.

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

Property Documentation

string UnifiedAutomation.UaServer.DataItemModel.Definition
getset

A vendor-specific, human readable string that specifies how the value of this DataItem is calculated.

Definition is non-localized and will often contain an equation that can be parsed by certain clients. Example: Definition::="(TempA - 25) + TempB"

double UnifiedAutomation.UaServer.DataItemModel.ValuePrecision
getset

Specifies the maximum precision that the server can maintain for the item based on restrictions in the target environment.

ValuePrecision can be used for the following DataTypes:

  • For Float and Double values it specifies the number of digits after the decimal place.
  • For DateTime values it indicates the minimum time difference in nanoseconds. For example, a ValuePrecision of 20 000 000 defines a precision of 20 ms.

The ValuePrecision Property is an approximation that is intended to provide guidance to a Client. A Server is expected to silently round any value with more precision that it supports. This implies that a Client may encounter cases where the value read back from a Server differs from the value that it wrote to the Server. This difference shall be no more than the difference suggested by this Property.


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