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

Provides access to a UA information model using classes with special attributes defined. More...

Public Member Functions

 MetadataMapper ()
 Initializes a new instance of the MetadataMapper class. More...
 
 MetadataMapper (Session session)
 Initializes a new instance of the MetadataMapper class. More...
 
 MetadataMapper (Session session, IMetadataMapper mapper)
 Initializes a new instance of the MetadataMapper class. More...
 
 MetadataMapper (Subscription subscription)
 Initializes a new instance of the MetadataMapper class. More...
 
 MetadataMapper (Subscription subscription, IMetadataMapper mapper)
 Initializes a new instance of the MetadataMapper class. More...
 
DataValue GetValue (MetadataMapping mapping)
 Gets the value associated with the mapping. More...
 
bool SetValue (MetadataMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 
MetadataHandle GetMetadataHandle (object instance)
 Gets the metadata handle. More...
 
MetadataHandleResult Read (NodeId rootId, MetadataHandle handle)
 Reads the object. More...
 
MetadataHandleResult Read (NodeId rootId, QualifiedName[] browsePath, MetadataHandle handle)
 Reads the object. More...
 
MetadataHandleResult Read (NodeId rootId, QualifiedName[] browsePath, MetadataHandle handle, RequestSettings settings)
 Reads the object. More...
 
IAsyncResult BeginRead (NodeId rootId, IList< QualifiedName > browsePath, MetadataHandle handle, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history read raw. More...
 
MetadataHandleResult EndRead (IAsyncResult result)
 Ends the history read raw. More...
 
MetadataHandleResult Write (NodeId rootId, MetadataHandle handle)
 Writes the object. More...
 
MetadataHandleResult Write (NodeId rootId, QualifiedName[] browsePath, MetadataHandle handle)
 Writes the object. More...
 
MetadataHandleResult Write (NodeId rootId, QualifiedName[] browsePath, MetadataHandle handle, RequestSettings settings)
 Writes the object. More...
 
IAsyncResult BeginWrite (NodeId rootId, IList< QualifiedName > browsePath, MetadataHandle handle, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the history Write raw. More...
 
MetadataHandleResult EndWrite (IAsyncResult result)
 Ends the history Write raw. More...
 
TypeDescription GetTypeDescription (NodeId typeId, TypeDescriptionSelection selection, RequestSettings settings)
 Begins the get method description. More...
 
IAsyncResult BeginGetTypeDescription (NodeId typeId, TypeDescriptionSelection selection, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the get method description. More...
 
TypeDescription EndGetTypeDescription (IAsyncResult result)
 Ends the get method description. More...
 
MethodDescription GetMethodDescription (NodeId methodId)
 Begins the get method description. More...
 
MethodDescription GetMethodDescription (NodeId methodId, RequestSettings settings)
 Begins the get method description. More...
 
MethodDescription GetMethodDescription (NodeId objectId, IList< QualifiedName > browsePath, RequestSettings settings)
 Begins the get method description. More...
 
IAsyncResult BeginGetMethodDescription (NodeId methodId, AsyncCallback callback, object userData)
 Begins the get method description. More...
 
IAsyncResult BeginGetMethodDescription (NodeId methodId, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the get method description. More...
 
IAsyncResult BeginGetMethodDescription (NodeId startingNodeId, IList< QualifiedName > browsePath, RequestSettings settings, AsyncCallback callback, object userData)
 Begins the get method description. More...
 
MethodDescription EndGetMethodDescription (IAsyncResult result)
 Ends the get method description. More...
 

Detailed Description

Provides access to a UA information model using classes with special attributes defined.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.MetadataMapper.MetadataMapper ( )
inline

Initializes a new instance of the MetadataMapper class.

UnifiedAutomation.UaClient.MetadataMapper.MetadataMapper ( Session  session)
inline

Initializes a new instance of the MetadataMapper class.

Parameters
sessionThe session.
UnifiedAutomation.UaClient.MetadataMapper.MetadataMapper ( Session  session,
IMetadataMapper  mapper 
)
inline

Initializes a new instance of the MetadataMapper class.

Parameters
sessionThe session.
mapperThe mapper.
UnifiedAutomation.UaClient.MetadataMapper.MetadataMapper ( Subscription  subscription)
inline

Initializes a new instance of the MetadataMapper class.

Parameters
subscriptionThe subscription.
UnifiedAutomation.UaClient.MetadataMapper.MetadataMapper ( Subscription  subscription,
IMetadataMapper  mapper 
)
inline

Initializes a new instance of the MetadataMapper class.

Parameters
subscriptionThe subscription.
mapperThe mapper.

Member Function Documentation

IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginGetMethodDescription ( NodeId  methodId,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get method description.

Parameters
methodIdThe method id.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginGetMethodDescription ( NodeId  methodId,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get method description.

Parameters
methodIdThe method id.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginGetMethodDescription ( NodeId  startingNodeId,
IList< QualifiedName browsePath,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get method description.

Parameters
startingNodeIdThe starting node id.
browsePathThe browse path.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
The async results.
IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginGetTypeDescription ( NodeId  typeId,
TypeDescriptionSelection  selection,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the get method description.

Parameters
typeIdThe type id.
selectionThe selection.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
The async results.
IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginRead ( NodeId  rootId,
IList< QualifiedName browsePath,
MetadataHandle  handle,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the history read raw.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
IAsyncResult UnifiedAutomation.UaClient.MetadataMapper.BeginWrite ( NodeId  rootId,
IList< QualifiedName browsePath,
MetadataHandle  handle,
RequestSettings  settings,
AsyncCallback  callback,
object  userData 
)
inline

Begins the history Write raw.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
settingsThe settings.
callbackThe callback.
userDataThe user data.
Returns
MethodDescription UnifiedAutomation.UaClient.MetadataMapper.EndGetMethodDescription ( IAsyncResult  result)
inline

Ends the get method description.

Parameters
resultThe result.
Returns
The method description.
TypeDescription UnifiedAutomation.UaClient.MetadataMapper.EndGetTypeDescription ( IAsyncResult  result)
inline

Ends the get method description.

Parameters
resultThe result.
Returns
The method description.
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.EndRead ( IAsyncResult  result)
inline

Ends the history read raw.

Parameters
resultThe result.
Returns
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.EndWrite ( IAsyncResult  result)
inline

Ends the history Write raw.

Parameters
resultThe result.
Returns
MetadataHandle UnifiedAutomation.UaClient.MetadataMapper.GetMetadataHandle ( object  instance)
inline

Gets the metadata handle.

Parameters
instanceThe instance.
Returns
MethodDescription UnifiedAutomation.UaClient.MetadataMapper.GetMethodDescription ( NodeId  methodId)
inline

Begins the get method description.

Parameters
methodIdThe method id.
Returns
MethodDescription UnifiedAutomation.UaClient.MetadataMapper.GetMethodDescription ( NodeId  methodId,
RequestSettings  settings 
)
inline

Begins the get method description.

Parameters
methodIdThe method id.
settingsThe settings.
Returns
MethodDescription UnifiedAutomation.UaClient.MetadataMapper.GetMethodDescription ( NodeId  objectId,
IList< QualifiedName browsePath,
RequestSettings  settings 
)
inline

Begins the get method description.

Parameters
objectIdThe object id.
browsePathThe browse path.
settingsThe settings.
Returns
TypeDescription UnifiedAutomation.UaClient.MetadataMapper.GetTypeDescription ( NodeId  typeId,
TypeDescriptionSelection  selection,
RequestSettings  settings 
)
inline

Begins the get method description.

Parameters
typeIdThe type id.
selectionThe selection.
settingsThe settings.
Returns
The async results.
DataValue UnifiedAutomation.UaClient.MetadataMapper.GetValue ( MetadataMapping  mapping)
inline

Gets the value associated with the mapping.

Parameters
mappingThe mapping.
Returns
The value. BadNoData if it does not exist.
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Read ( NodeId  rootId,
MetadataHandle  handle 
)
inline

Reads the object.

Parameters
rootIdThe root id.
handleThe handle.
Returns
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Read ( NodeId  rootId,
QualifiedName[]  browsePath,
MetadataHandle  handle 
)
inline

Reads the object.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
Returns
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Read ( NodeId  rootId,
QualifiedName[]  browsePath,
MetadataHandle  handle,
RequestSettings  settings 
)
inline

Reads the object.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
settingsThe settings.
Returns
bool UnifiedAutomation.UaClient.MetadataMapper.SetValue ( MetadataMapping  mapping,
DataValue  value 
)
inline

Sets the value associated with the mapping.

Parameters
mappingThe mapping.
valueThe value.
Returns
True if the mapping was understood. False otherwise.
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Write ( NodeId  rootId,
MetadataHandle  handle 
)
inline

Writes the object.

Parameters
rootIdThe root id.
handleThe handle.
Returns
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Write ( NodeId  rootId,
QualifiedName[]  browsePath,
MetadataHandle  handle 
)
inline

Writes the object.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
Returns
MetadataHandleResult UnifiedAutomation.UaClient.MetadataMapper.Write ( NodeId  rootId,
QualifiedName[]  browsePath,
MetadataHandle  handle,
RequestSettings  settings 
)
inline

Writes the object.

Parameters
rootIdThe root id.
browsePathThe browse path.
handleThe handle.
settingsThe settings.
Returns

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