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

Inherits UnifiedAutomation.UaClient.SessionMethodHelper.

Public Member Functions
	DataTypeManager (ApplicationInstanceBase application)
	Initializes a new instance of the DataTypeManager class. More...

	DataTypeManager (Session session)
	Initializes a new instance of the DataTypeManager class. More...

DataTypeDictionary	AddDictionaryToCache (NodeId typeSystemId, ExpandedNodeId dictionaryId, byte[] schemaData)
	Adds or replaces the dictionary in the local cache. More...

DataTypeDictionary	FindDictionaryInCache (ExpandedNodeId dictionaryId)
	Finds the data type dictionary in the local cache. More...

DataTypeDescription	FindDescriptionInCache (ExpandedNodeId descriptionId)
	Finds the data type description in the local cache. More...

DataTypeDescription	FindEncodingInCache (ExpandedNodeId encodingId)
	Finds the data type description for the encoding in the local cache. More...

GenericStructureDataType	NewTypeFromDataType (ExpandedNodeId dataTypeId, QualifiedName encodingName, bool doNotUseCache)
	Creates a new generic data type instance for an encoding. More...

GenericStructureDataType	NewTypeFromEncoding (ExpandedNodeId encodingId, bool doNotUseCache)
	Creates a new generic data type instance for an encoding. More...

DataTypeDictionary	GetDictionary (ExpandedNodeId dictionaryId)
	Reads the DataType Dictionary from the server and updates the local cache. More...

IAsyncResult	BeginGetDictionary (ExpandedNodeId dictionaryId, AsyncCallback callback, object callbackData)
	Begins an operation to read the DataType Dictionary from the server and updates the local cache. More...

DataTypeDictionary	EndGetDictionary (IAsyncResult result)
	Completes an operation to read the DataType Dictionary from the server and updates the local cache. More...

Dictionary< string, DataTypeDictionaryIdentity >	GetAvailableDictionaries (NodeId typeSystemId)
	Reads the available DataType Dictionaries from the server and updates the local cache. More...

IAsyncResult	BeginGetAvailableDictionaries (NodeId typeSystemId, AsyncCallback callback, object callbackData)
	Begins an operation to read the available DataType Dictionaries from the server and updates the local cache. More...

Dictionary< string, DataTypeDictionaryIdentity >	EndGetAvailableDictionaries (IAsyncResult result)
	Completes an operation to read the DataType Dictionary from the server and updates the local cache. More...

DataTypeDescription	GetDescriptionFromEncoding (ExpandedNodeId encodingId, bool doNotUseCache)
	Gets the DataType Description from the DataType Encoding. More...

IAsyncResult	BeginGetDescriptionFromEncoding (ExpandedNodeId encodingId, bool doNotUseCache, 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...

DataTypeDescription	GetDescriptionFromDataType (ExpandedNodeId dataTypeId, QualifiedName encodingName, bool doNotUseCache)
	Gets the DataType Description associated with a DataType. More...

IAsyncResult	BeginGetDescriptionFromDataType (ExpandedNodeId dataTypeId, QualifiedName encodingName, bool doNotUseCache, AsyncCallback callback, object callbackData)
	Begins an operation to get the 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...

GenericEncodeableObject	ParseValue (ExtensionObject value)
	Parses the value. More...

IAsyncResult	BeginParseValue (ExtensionObject value, AsyncCallback callback, object callbackData)
	Begins the parse value. More...

GenericEncodeableObject	EndParseValue (IAsyncResult result)
	Begins the parse value. More...

Public Member Functions inherited from UnifiedAutomation.UaClient.SessionMethodHelper
	SessionMethodHelper (ApplicationInstanceBase 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...

Properties
int	BlockSize `[get, set]`
	Gets or sets the size of the block used when reading dictionaries from the server. More...

Properties inherited from UnifiedAutomation.UaClient.SessionMethodHelper
string	EndpointUrl `[get, set]`
	Gets or sets the endpoint URL. More...

Session	Session `[get]`
	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...

bool	MustCloseSession `[get]`
	A flag indicating that the object created the session and therefore must close it. 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...

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

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

Structured DataTypes using structured DataTypes from other namespaces are not supported.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.DataTypeManager.DataTypeManager ( ApplicationInstanceBase application )

inline

Initializes a new instance of the DataTypeManager class.

Parameters

application The application.

Exceptions

System.ArgumentNullException application

UnifiedAutomation.UaClient.DataTypeManager.DataTypeManager ( Session session )

inline

Initializes a new instance of the DataTypeManager class.

Parameters

session The session.

Exceptions

System.ArgumentNullException session

Member Function Documentation

DataTypeDictionary UnifiedAutomation.UaClient.DataTypeManager.AddDictionaryToCache	(	NodeId	typeSystemId,
		ExpandedNodeId	dictionaryId,
		byte[]	schemaData
	)

inline

Adds or replaces the dictionary in the local cache.

Parameters

typeSystemId	The type system identifier.
dictionaryId	The dictionary identifier.
schemaData	The schema data (an OPCBinary or XMLSchema document).

IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetAvailableDictionaries	(	NodeId	typeSystemId,
		AsyncCallback	callback,
		object	callbackData
	)

inline

Begins an operation to read the available DataType Dictionaries from the server and updates the local cache.

Parameters

typeSystemId	The type system identifier.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

Exceptions

System.ArgumentNullException dictionaryId

IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetDescriptionFromDataType	(	ExpandedNodeId	dataTypeId,
		QualifiedName	encodingName,
		bool	doNotUseCache,
		AsyncCallback	callback,
		object	callbackData
	)

inline

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

Parameters

dataTypeId	The data type identifier.
encodingName	Name of the encoding to used when finding the description.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

Exceptions

System.ArgumentNullException dataTypeId

IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetDescriptionFromEncoding	(	ExpandedNodeId	encodingId,
		bool	doNotUseCache,
		AsyncCallback	callback,
		object	callbackData
	)

inline

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

Parameters

encodingId	The data type encoding identifier.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

Exceptions

System.ArgumentNullException dataTypeId

IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginGetDictionary	(	ExpandedNodeId	dictionaryId,
		AsyncCallback	callback,
		object	callbackData
	)

inline

Begins an operation to read the DataType Dictionary from the server and updates the local cache.

Parameters

dictionaryId	The data type dictionary identifier.
callback	The callback.
callbackData	The callback data.

Returns: The object used to manage the state of the asynchronous operation.

Exceptions

System.ArgumentNullException dictionaryId

IAsyncResult UnifiedAutomation.UaClient.DataTypeManager.BeginParseValue	(	ExtensionObject	value,
		AsyncCallback	callback,
		object	callbackData
	)

inline

Begins the parse value.

Parameters

value	The value.
callback	The callback.
callbackData	The callback data.

Returns: The parsed value.

Exceptions

System.ArgumentNullException value

Dictionary<string, DataTypeDictionaryIdentity> UnifiedAutomation.UaClient.DataTypeManager.EndGetAvailableDictionaries ( IAsyncResult result )

inline

Completes an operation to read the DataType Dictionary from the server and updates the local cache.

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The data type Dictionary associated with the data type.

Exceptions

System.ArgumentNullException result

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.EndGetDescriptionFromDataType ( IAsyncResult result )

inline

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

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The data type description associated with the data type.

Exceptions

System.ArgumentNullException result

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.EndGetDescriptionFromEncoding ( IAsyncResult result )

inline

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

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The data type description associated with the data type.

Exceptions

System.ArgumentNullException result

DataTypeDictionary UnifiedAutomation.UaClient.DataTypeManager.EndGetDictionary ( IAsyncResult result )

inline

Completes an operation to read the DataType Dictionary from the server and updates the local cache.

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The data type Dictionary associated with the data type.

Exceptions

System.ArgumentNullException result

GenericEncodeableObject UnifiedAutomation.UaClient.DataTypeManager.EndParseValue ( IAsyncResult result )

inline

Begins the parse value.

Parameters

result The object used to manage the state of the asynchronous operation.

Returns: The parsed value.

Exceptions

System.ArgumentNullException result

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.FindDescriptionInCache ( ExpandedNodeId descriptionId )

inline

Finds the data type description in the local cache.

Parameters

descriptionId The data type description identifier.

Returns: The cached data type description; null if not found.

DataTypeDictionary UnifiedAutomation.UaClient.DataTypeManager.FindDictionaryInCache ( ExpandedNodeId dictionaryId )

inline

Finds the data type dictionary in the local cache.

Parameters

dictionaryId The data dictionary identifier.

Returns: The cached data type dictionary; null if not found.

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.FindEncodingInCache ( ExpandedNodeId encodingId )

inline

Finds the data type description for the encoding in the local cache.

Parameters

encodingId The encoding identifier.

Returns: The cached data type description; null if not found.

Dictionary<string, DataTypeDictionaryIdentity> UnifiedAutomation.UaClient.DataTypeManager.GetAvailableDictionaries ( NodeId typeSystemId )

inline

Reads the available DataType Dictionaries from the server and updates the local cache.

Parameters

typeSystemId The type system identifier.

Returns: The data type dictionary.

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.GetDescriptionFromDataType	(	ExpandedNodeId	dataTypeId,
		QualifiedName	encodingName,
		bool	doNotUseCache
	)

inline

Gets the DataType Description associated with a DataType.

Parameters

dataTypeId	The data type identifier.
encodingName	Name of the encoding to used when finding the description.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.

Returns: The data type description associated with the data type.

DataTypeDescription UnifiedAutomation.UaClient.DataTypeManager.GetDescriptionFromEncoding	(	ExpandedNodeId	encodingId,
		bool	doNotUseCache
	)

inline

Gets the DataType Description from the DataType Encoding.

Parameters

encodingId	The data type encoding identifier.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.

Returns: The data type description associated with the data type.

DataTypeDictionary UnifiedAutomation.UaClient.DataTypeManager.GetDictionary ( ExpandedNodeId dictionaryId )

inline

Reads the DataType Dictionary from the server and updates the local cache.

Parameters

dictionaryId The data type dictionary identifier.

Returns: The data type dictionary.

GenericStructureDataType UnifiedAutomation.UaClient.DataTypeManager.NewTypeFromDataType	(	ExpandedNodeId	dataTypeId,
		QualifiedName	encodingName,
		bool	doNotUseCache
	)

inline

Creates a new generic data type instance for an encoding.

Parameters

dataTypeId	The data type identifier.
encodingName	The name of the data type encoding.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.

Returns: A new generic data type.

GenericStructureDataType UnifiedAutomation.UaClient.DataTypeManager.NewTypeFromEncoding	(	ExpandedNodeId	encodingId,
		bool	doNotUseCache
	)

inline

Creates a new generic data type instance for an encoding.

Parameters

encodingId	The encoding identifier.
doNotUseCache	If TRUE the information will be read from the server and the contents of the cache will be updated.

Returns: A new generic data type.

GenericEncodeableObject UnifiedAutomation.UaClient.DataTypeManager.ParseValue ( ExtensionObject value )

inline

Parses the value.

Parameters

value The value.

Returns: The parsed value.

Property Documentation

int UnifiedAutomation.UaClient.DataTypeManager.BlockSize

getset

Gets or sets the size of the block used when reading dictionaries from the server.

The size of the block used when reading dictionaries from the server.

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

D:/work/uasdknet/src/UaClient/DataTypeManager.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation