.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.EncodeableFactory Class Reference

Creates encodeable objects based on the type id. More...

Public Member Functions

 EncodeableFactory ()
 Creates a factory initialized with the types in the core library. More...
 
 EncodeableFactory (bool shared)
 Creates a factory which is marked as shared and initialized with the types in the core library. More...
 
 EncodeableFactory (EncodeableFactory factory)
 Creates a factory by copying the table from another factory. More...
 
void AddEncodeableType (System.Type systemType)
 Adds an extension type to the factory. More...
 
void AddEncodeableType (ExpandedNodeId encodingId, System.Type systemType)
 Associates an encodeable type with an encoding id. More...
 
void AddGenericDataTypeMapping (GenericStructureDataType genericType)
 Adds a mapping between a generic structure definition for a data type/encoding id. More...
 
bool RemoveGenericDataTypeMapping (ExpandedNodeId dataTypeId)
 Removes a mapping between a generic structure definition for a data type/encoding id. More...
 
void AddEncodeableTypes (Assembly assembly)
 Adds all encodable types exported from an assembly to the factory. More...
 
System.Type GetSystemType (ExpandedNodeId typeId)
 Returns the system type for the specified type id. More...
 
GenericStructureDataType GetGenericType (ExpandedNodeId typeId)
 Returns the generic type for the specified type id. More...
 

Static Public Member Functions

static XmlQualifiedName GetXmlName (System.Type systemType)
 Returns the xml qualified name for the specified system type id. More...
 

Properties

static EncodeableFactory GlobalFactory [get]
 The default factory for the process. More...
 
object SyncRoot [get]
 Returns the object used to synchronize access to the factory. More...
 
int InstanceId [get]
 Returns a unique identifier for the table instance. Used to debug problems with shared tables. More...
 

Detailed Description

Creates encodeable objects based on the type id.

This factory is used to store and retrieve underlying OPC UA system types.

You can manually add types. You can also import all types from a specified assembly. Once the types exist within the factory, these types can be then easily queried.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.EncodeableFactory.EncodeableFactory ( )
inline

Creates a factory initialized with the types in the core library.

UnifiedAutomation.UaBase.EncodeableFactory.EncodeableFactory ( bool  shared)
inline

Creates a factory which is marked as shared and initialized with the types in the core library.

UnifiedAutomation.UaBase.EncodeableFactory.EncodeableFactory ( EncodeableFactory  factory)
inline

Creates a factory by copying the table from another factory.

Member Function Documentation

void UnifiedAutomation.UaBase.EncodeableFactory.AddEncodeableType ( System.Type  systemType)
inline

Adds an extension type to the factory.

Adds an extension type to the factory.

Parameters
systemTypeThe underlying system type to add to the factory
void UnifiedAutomation.UaBase.EncodeableFactory.AddEncodeableType ( ExpandedNodeId  encodingId,
System.Type  systemType 
)
inline

Associates an encodeable type with an encoding id.

Parameters
encodingIdA NodeId for a Data Type Encoding node
systemTypeThe system type to use for the specified encoding.
void UnifiedAutomation.UaBase.EncodeableFactory.AddEncodeableTypes ( Assembly  assembly)
inline

Adds all encodable types exported from an assembly to the factory.

Adds all encodable types exported from an assembly to the factory.

This method uses reflection on the specified assembly to export all of the types the assembly exposes, and automatically adds all types that implement the IEncodeable interface, to the factory.

Parameters
assemblyThe assembly containing the types to add to the factory
void UnifiedAutomation.UaBase.EncodeableFactory.AddGenericDataTypeMapping ( GenericStructureDataType  genericType)
inline

Adds a mapping between a generic structure definition for a data type/encoding id.

Parameters
genericTypeThe generic structure definition. The node ids mapped to the definition are properties of this object.
GenericStructureDataType UnifiedAutomation.UaBase.EncodeableFactory.GetGenericType ( ExpandedNodeId  typeId)
inline

Returns the generic type for the specified type id.

Returns the generic type for the specified type id.

Parameters
typeIdThe type id to return the system-type of
System.Type UnifiedAutomation.UaBase.EncodeableFactory.GetSystemType ( ExpandedNodeId  typeId)
inline

Returns the system type for the specified type id.

Returns the system type for the specified type id.

Parameters
typeIdThe type id to return the system-type of
static XmlQualifiedName UnifiedAutomation.UaBase.EncodeableFactory.GetXmlName ( System.Type  systemType)
inlinestatic

Returns the xml qualified name for the specified system type id.

Returns the xml qualified name for the specified system type id.

Parameters
systemTypeThe underlying type to query and return the Xml qualified name of
bool UnifiedAutomation.UaBase.EncodeableFactory.RemoveGenericDataTypeMapping ( ExpandedNodeId  dataTypeId)
inline

Removes a mapping between a generic structure definition for a data type/encoding id.

Parameters
dataTypeIdThe data type or encoding id to remove from the mapping.
Returns
TRUE if the type exists and was removed; FALSE otherwise.

Property Documentation

EncodeableFactory UnifiedAutomation.UaBase.EncodeableFactory.GlobalFactory
staticget

The default factory for the process.

The default factory for the process.

int UnifiedAutomation.UaBase.EncodeableFactory.InstanceId
get

Returns a unique identifier for the table instance. Used to debug problems with shared tables.

object UnifiedAutomation.UaBase.EncodeableFactory.SyncRoot
get

Returns the object used to synchronize access to the factory.

Returns the object used to synchronize access to the factory.


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