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

EXPERIMENTAL: This type is a prototype for a not released feature. The type is subject to change. Do not use this type in a product. More...

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions

 DataTypeManager (ApplicationInstance application)
 Initializes a new instance of the DataTypeManager class. More...
 
 DataTypeManager (Session session)
 Initializes a new instance of the DataTypeManager class. More...
 
void AddDictionaryToCache (NodeId typeSystemId, NodeId dictionaryId, byte[] schemaData, ISchemaParser parser)
 Adds or replaces the dictionary in the local cache. More...
 
DataTypeDictionary FindDictionaryInCache (NodeId dictionaryId)
 Finds the data type dictionary in the local cache. More...
 
DataTypeDescription FindDataTypeInCache (ExpandedNodeId dataTypeId)
 Finds the data type description in the local cache. More...
 
DataTypeDescription GetDescriptionFromDataType (NodeId dataTypeId)
 Gets the OPCBinary DataType Description associated with a DataType. More...
 
IAsyncResult BeginGetDescriptionFromDataType (NodeId dataTypeId, AsyncCallback callback, object callbackData)
 Begins an operation to get the OPCBinary DataType Description associated with a DataType. More...
 
DataTypeDescription EndGetDescriptionFromDataType (IAsyncResult result)
 Completes an operation to get the OPCBinary DataType Description associated with a DataType. More...
 
DataTypeDescription GetDescriptionFromEncoding (ExpandedNodeId encodingId)
 Gets the DataType Description from the DataType Encoding. More...
 
IAsyncResult BeginGetDescriptionFromEncoding (ExpandedNodeId encodingId, AsyncCallback callback, object callbackData)
 Begins an operation to get the DataType Description from the DataType Encoding. More...
 
DataTypeDescription EndGetDescriptionFromEncoding (IAsyncResult result)
 Completes an operation to gets the DataType Description from the DataType Encoding. More...
 
GenericValue ParseValue (ExtensionObject value)
 Parses the value. More...
 
IAsyncResult BeginParseValue (ExtensionObject value, AsyncCallback callback, object callbackData)
 Begins the parse value. More...
 
GenericValue EndParseValue (IAsyncResult result)
 
- Public Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
 SessionMethodHelper (ApplicationInstance application)
 Initializes a new instance of the SessionMethodHelper class. More...
 
 SessionMethodHelper (Session session)
 Initializes a new instance of the SessionMethodHelper class. More...
 
void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
void Connect (int timeout)
 Connects to the server. More...
 
void BeginConnect (AsyncCallback callback, object callbackData)
 Connects to the server. More...
 
void Disconnect ()
 Disconnects from the server. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
virtual void Dispose (bool disposing)
 Releases unmanaged and—optionally—managed resources. More...
 
UserIdentity RequestAdminCredentials ()
 Gets the admin credentials. More...
 
- Properties inherited from UnifiedAutomation.UaClient.SessionMethodHelper
string EndpointUrl [get, set]
 Gets or sets the endpoint URL. More...
 
Session Session [get, set]
 Gets the session. More...
 
RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 
int DefaultTimeout [get]
 Gets the default timeout. More...
 
UserIdentity AdminCredentials [get, set]
 Gets or sets the administrator credentials. More...
 
bool IsConnected [get]
 Gets a value indicating whether a connection to the server is active. More...
 
- Events inherited from UnifiedAutomation.UaClient.SessionMethodHelper
EventHandler ServerStatusChanged
 Occurs when the server status changes. More...
 
EventHandler
< CredentialsRequiredEventArgs
AdminCredentialsRequired
 Raised when admin credentials are required. More...
 

Detailed Description

EXPERIMENTAL: This type is a prototype for a not released feature. The type is subject to change. Do not use this type in a product.

An object which manages access to the data type dictionaries exposed by a server.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.DataTypeManager.DataTypeManager ( ApplicationInstance  application)
inline

Initializes a new instance of the DataTypeManager class.

Parameters
applicationThe application.
Exceptions
System.ArgumentNullExceptionapplication
UnifiedAutomation.UaClient.DataTypeManager.DataTypeManager ( Session  session)
inline

Initializes a new instance of the DataTypeManager class.

Parameters
sessionThe session.
Exceptions
System.ArgumentNullExceptionsession

Member Function Documentation

void UnifiedAutomation.UaClient.DataTypeManager.AddDictionaryToCache ( NodeId  typeSystemId,
NodeId  dictionaryId,
byte[]  schemaData,
ISchemaParser  parser 
)
inline

Adds or replaces the dictionary in the local cache.

Parameters
typeSystemIdThe type system identifier.
dictionaryIdThe dictionary identifier.
schemaDataThe schema data (an OPCBinary or XMLSchema document).
parserThe parser used to process instances. The default parser is used if this is null.
IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetDescriptionFromDataType ( NodeId  dataTypeId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to get the OPCBinary DataType Description associated with a DataType.

Parameters
dataTypeIdThe data type identifier.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
Exceptions
System.ArgumentNullExceptiondataTypeId
IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetDescriptionFromEncoding ( ExpandedNodeId  encodingId,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an operation to get the DataType Description from the DataType Encoding.

Parameters
encodingIdThe data type encoding identifier.
callbackThe callback.
callbackDataThe callback data.
Returns
The object used to manage the state of the asynchronous operation.
Exceptions
System.ArgumentNullExceptiondataTypeId
IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginParseValue ( ExtensionObject  value,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins the parse value.

Parameters
valueThe value.
callbackThe callback.
callbackDataThe callback data.
Returns
The parsed value.
Exceptions
System.ArgumentNullExceptionvalue
DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.EndGetDescriptionFromDataType ( IAsyncResult  result)
inline

Completes an operation to get the OPCBinary DataType Description associated with a DataType.

Parameters
resultThe object used to manage the state of the asynchronous operation.
Returns
The data type description associated with the data type.
Exceptions
System.ArgumentNullExceptionresult
DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.EndGetDescriptionFromEncoding ( IAsyncResult  result)
inline

Completes an operation to gets the DataType Description from the DataType Encoding.

Parameters
resultThe object used to manage the state of the asynchronous operation.
Returns
The data type description associated with the data type.
Exceptions
System.ArgumentNullExceptionresult
GenericValue UnifiedAutomation.UaClient.DataTypeManager.EndParseValue ( IAsyncResult  result)
inline
Parameters
resultThe object used to manage the state of the asynchronous operation.
Returns
The parsed value.
Exceptions
System.ArgumentNullExceptionresult
DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.FindDataTypeInCache ( ExpandedNodeId  dataTypeId)
inline

Finds the data type description in the local cache.

Parameters
dataTypeIdThe data type identifier.
Returns
The cached data type description; null if not found.
DataTypeDictionary UnifiedAutomation.UaClient.DataTypeManager.FindDictionaryInCache ( NodeId  dictionaryId)
inline

Finds the data type dictionary in the local cache.

Parameters
dictionaryIdThe data dictionary identifier.
Returns
The cached data type dictionary; null if not found.
DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.GetDescriptionFromDataType ( NodeId  dataTypeId)
inline

Gets the OPCBinary DataType Description associated with a DataType.

Parameters
dataTypeIdThe data type identifier.
Returns
The data type description associated with the data type.
DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.GetDescriptionFromEncoding ( ExpandedNodeId  encodingId)
inline

Gets the DataType Description from the DataType Encoding.

Parameters
encodingIdThe data type encoding identifier.
Returns
The data type description associated with the data type.
GenericValue UnifiedAutomation.UaClient.DataTypeManager.ParseValue ( ExtensionObject  value)
inline

Parses the value.

Parameters
valueThe value.
Returns
The parsed value.

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