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

Used as the type for the DataTypeDescriptions. More...

Inherits UnifiedAutomation.UaServer.BaseDataVariableModel.

Public Member Functions

 DataTypeDescriptionModel ()
 Initializes a new instance of the DataTypeDescriptionModel class. More...
 
 DataTypeDescriptionModel (DataTypeDescriptionModel template, DummyArgument dummy=null)
 Initializes a new instance of the DataTypeDescriptionModel 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

new string Value [get, set]
 Gets or sets the value. More...
 
string DataTypeVersion [get, set]
 DataTypeVersion indicates whether the type description of the DataType has changed. More...
 
byte[] DictionaryFragment [get, set]
 A ByteString that contains a subset of the DataTypeDictionary which describes the format of the DataType associated with the DataTypeDescription. 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

Used as the type for the DataTypeDescriptions.

There are no References specified for this VariableType. It defines the optional properties DataTypeVersion and DictionaryFragment.

DataTypeVersion indicates whether the type description of the DataType has changed. Changes to the DataTypeVersion may impact the operation of Subscriptions. If the DataTypeVersion changes for a Variable that is being monitored for a Subscription and that uses this DataTypeDescription, then the next data change Notification sent for the Variable will contain a status that indicates the change in the DataTypeDescription.

In some scenarios an OPC UA Server may have resource limitations which make it impractical to expose large DataTypeDictionaries. In these scenarios the Server may be able to provide access to descriptions for individual DataTypes even if the entire dictionary cannot be read. For this reason, this standard defines a Property for the DataTypeDescription called DictionaryFragment. This Property is a ByteString that contains a subset of the DataTypeDictionary which describes the format of the DataType associated with the DataTypeDescription. Thus, the Server splits the large DataTypeDictionary into several small parts and Clients can access without affecting the overall system performance.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.DataTypeDescriptionModel.DataTypeDescriptionModel ( )

Initializes a new instance of the DataTypeDescriptionModel class.

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

Initializes a new instance of the DataTypeDescriptionModel class.

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

Property Documentation

string UnifiedAutomation.UaServer.DataTypeDescriptionModel.DataTypeVersion
getset

DataTypeVersion indicates whether the type description of the DataType has changed.

byte [] UnifiedAutomation.UaServer.DataTypeDescriptionModel.DictionaryFragment
getset

A ByteString that contains a subset of the DataTypeDictionary which describes the format of the DataType associated with the DataTypeDescription.

new string UnifiedAutomation.UaServer.DataTypeDescriptionModel.Value
getset

Gets or sets the value.


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