Reference
OpcDataTypeSystem Members
Represents an encoding-based system which is organized in type dictionaries to define type information to use to understand data exchanged via OPC UA using a specific type of encoding.
Reference
OpcDataTypeSystem Members
- Type
- OpcDataTypeSystem
- Namespace
- Opc.UaFx
- Assembly
- Opc.UaFx.Advanced.dll
- Package
- Opc.UaFx.Advanced v2.59.0
- Also in
- Opc.UaFx.Client
Inherits members from OpcTypeSystem<OpcDataTypeInfo>.
Properties
Binary
Gets the type system used for Binary encoded type information offered by the Client or Server application.
public static OpcDataTypeSystem Binary { get; }Public Shared ReadOnly Property Binary As OpcDataTypeSystemProperty value
An instance of the OpcDataTypeSystem class which contains the type dictionaries described by the Types using the OpcDataTypeEncodingAttribute with the Binary encoding type implemented in the application which uses the OPC UA SDK.
Default
Gets the default type system used by the OPC UA stack.
public static OpcDataTypeSystem Default { get; }Public Shared ReadOnly Property [Default] As OpcDataTypeSystemProperty value
An instance of the OpcDataTypeSystem class which contains the type dictionaries used by default in Client and Server applications.
Remarks
The information offered by the default OpcDataTypeSystem is embedded in the OPC UA SDK and is therefore determined from the resources of the assembly whenever required.
Empty
Gets the type system to use if their is no specific type system data available.
public static OpcDataTypeSystem Empty { get; }Public Shared ReadOnly Property Empty As OpcDataTypeSystemProperty value
An instance of the OpcDataTypeSystem class which contains no type dictionary nor type information.
EmptyDictionary
Gets the type dictionary to use if their is no specific type dictionary data available, but the empty type dictionary shall refer to the current OpcDataTypeSystem.
public OpcDataTypeDictionary EmptyDictionary { get; }Public ReadOnly Property EmptyDictionary As OpcDataTypeDictionaryProperty value
An instance of the OpcDataTypeDictionary class which refers to the current OpcDataTypeSystem.
EncodingType
Gets the type of encoding used for the data type dictionaries defined in the current OpcDataTypeSystem.
public OpcEncodingType EncodingType { get; }Public ReadOnly Property EncodingType As OpcEncodingTypeProperty value
One of the members defined by the OpcEncodingType enumeration.
FallbackDataTypeSystem
Gets the data type system used as the fallback system to query data type information which is referenced in the current OpcDataTypeSystem but is not declared.
public OpcDataTypeSystem FallbackDataTypeSystem { get; }Public ReadOnly Property FallbackDataTypeSystem As OpcDataTypeSystemProperty value
An instance of the OpcDataTypeSystem class used to query data type information which is referenced but not declared within the current OpcDataTypeSystem or a null reference (Nothing in Visual Basic) if the current OpcDataTypeSystem is independent from a different data type system. Such data type systems typically declare types which only reference others declared in the same system as well.
HasCachedDictionaries
Gets a value indicating whether the type system already has determined at least some type dictionaries offered as OpcDataTypeDictionary objects.
protected bool HasCachedDictionaries { get; }Protected ReadOnly Property HasCachedDictionaries As BooleanProperty value
The value true if the system offers already prepared OpcDataTypeDictionary objects; otherwise the value false.
HasCachingCompleted
Gets a value indicating whether the type system has determined all type dictionaries offered as OpcDataTypeDictionary objects.
protected virtual bool HasCachingCompleted { get; }Protected Overridable Property HasCachingCompleted As BooleanProperty value
The value true if the system has completed its type dictionary retrieval and will use its internal cache to determine OpcDataTypeDictionary objects; otherwise the value false.
Name
Gets a value which defines the human-readable name of the type system represented. A node which represents this OpcDataTypeSystem uses the Name as its BrowseName.
public OpcName Name { get; }Public ReadOnly Property Name As OpcNameProperty value
An instance of the OpcName class with the string used as the name of the type system which does not unambiguously identify the OpcDataTypeSystem.
NodeId
Gets a value which identifies the type system represented. A node which represents this OpcDataTypeSystem uses the NodeId as its NodeId.
public OpcNodeId NodeId { get; }Public ReadOnly Property NodeId As OpcNodeIdProperty value
An instance of the OpcNodeId class used as the identifier of the type system which unambiguously identifies the OpcDataTypeSystem.
Xml
Gets the type system used for Xml encoded type information offered by the Client or Server application.
public static OpcDataTypeSystem Xml { get; }Public Shared ReadOnly Property Xml As OpcDataTypeSystemProperty value
An instance of the OpcDataTypeSystem class which contains the type dictionaries described by the Types using the OpcDataTypeEncodingAttribute with the Xml encoding type implemented in the application which uses the OPC UA SDK.
Methods
GetDictionaries
Retrieves all OpcDataTypeDictionary objects offered by the OpcDataTypeSystem.
public OpcDataTypeDictionary[] GetDictionaries()Public Function GetDictionaries() As OpcDataTypeDictionary()Returns
An array that contains all OpcDataTypeDictionary objects that are offered by the OpcDataTypeSystem.
GetDictionary
| Overload | Description |
|---|---|
| GetDictionary( | Retrieves the OpcnameOrNamespace specified. |
| GetDictionary( | Retrieves the Opcname specified. |
| GetDictionary( | Retrieves the Opcnamespace specified. |
| GetDictionary( | Retrieves the OpcnodeId specified. |
GetDictionary(string)
Retrieves the OpcDataTypeDictionary object which is known under the nameOrNamespace specified.
public OpcDataTypeDictionary GetDictionary(string nameOrNamespace)Public Function GetDictionary(
nameOrNamespace As String) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
nameOrNamespace | String | The string to use to identify the Opc |
Returns
The OpcDataTypeDictionary object its Name (regarding its Value) or its Namespace (regarding its Value) or its XmlNamespace is equals to the nameOrNamespace specified; otherwise a null reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nameOrNamespace is equals Empty. |
| Argument | The nameOrNamespace is a null reference ( |
GetDictionary(OpcName)
Retrieves the OpcDataTypeDictionary object which is known under the name specified.
public OpcDataTypeDictionary GetDictionary(OpcName name)Public Function GetDictionary(name As OpcName) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName of the Opc |
Returns
The OpcDataTypeDictionary object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| Argument | The name is a null reference ( |
GetDictionary(OpcNamespace)
Retrieves the OpcDataTypeDictionary object which is known under the namespace specified.
public OpcDataTypeDictionary GetDictionary(OpcNamespace @namespace)Public Function GetDictionary(
[namespace] As OpcNamespace) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
namespace | OpcNamespace | The OpcNamespace of the Opc |
Returns
The OpcDataTypeDictionary object its Namespace is equals to the namespace specified; otherwise a null reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| Argument | The namespace is a null reference ( |
GetDictionary(OpcNodeId)
Retrieves the OpcDataTypeDictionary object which represents the type dictionary which is identified by the nodeId specified.
public OpcDataTypeDictionary GetDictionary(OpcNodeId nodeId)Public Function GetDictionary(nodeId As OpcNodeId) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the Opc |
Returns
The OpcDataTypeDictionary object which is known under the nodeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeDictionary object which is associated with the nodeId specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The nodeId is a null reference ( |
GetDictionaryCore
| Overload | Description |
|---|---|
| Get | Retrieves the OpcnameOrNamespace specified. |
| Get | Retrieves the Opcname specified. |
| Get | Retrieves the Opcnamespace specified. |
| Get | Retrieves the OpcnodeId specified. |
GetDictionaryCore(string)
Retrieves the OpcDataTypeDictionary object which is known under the nameOrNamespace specified.
protected virtual OpcDataTypeDictionary GetDictionaryCore(
string nameOrNamespace)Protected Overridable Function GetDictionaryCore(
nameOrNamespace As String) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
nameOrNamespace | String | The string to use to identify the Opc |
Returns
The OpcDataTypeDictionary object its Name (regarding its Value) or its Namespace (regarding its Value) or its XmlNamespace is equals to the nameOrNamespace specified; otherwise a null reference (Nothing in Visual Basic).
Remarks
It is already assured that the passed nameOrNamespace is not a null reference (Nothing in Visual Basic) nor equals Empty. In case there this method is not implemented in a derived class this method determines the type dictionary from a distinct and on-demand determined sequence which combines the OpcDataTypeDictionary objects offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval.
GetDictionaryCore(OpcName)
Retrieves the OpcDataTypeDictionary object which is known under the name specified.
protected virtual OpcDataTypeDictionary GetDictionaryCore(OpcName name)Protected Overridable Function GetDictionaryCore(
name As OpcName) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName of the Opc |
Returns
The OpcDataTypeDictionary object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).
Remarks
It is already assured that the passed name is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type dictionary from a distinct and on-demand determined sequence which combines the OpcDataTypeDictionary objects offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval.
GetDictionaryCore(OpcNamespace)
Retrieves the OpcDataTypeDictionary object which is known under the namespace specified.
protected virtual OpcDataTypeDictionary GetDictionaryCore(
OpcNamespace @namespace)Protected Overridable Function GetDictionaryCore(
[namespace] As OpcNamespace) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
namespace | OpcNamespace | The OpcNamespace of the Opc |
Returns
The OpcDataTypeDictionary object its Namespace is equals to the namespace specified; otherwise a null reference (Nothing in Visual Basic).
Remarks
It is already assured that the passed namespace is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type dictionary from a distinct and on-demand determined sequence which combines the OpcDataTypeDictionary objects offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval.
GetDictionaryCore(OpcNodeId)
Retrieves the OpcDataTypeDictionary object which represents the type dictionary which is identified by the nodeId specified.
protected virtual OpcDataTypeDictionary GetDictionaryCore(OpcNodeId nodeId)Protected Overridable Function GetDictionaryCore(
nodeId As OpcNodeId) As OpcDataTypeDictionaryParameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId which identifies the Opc |
Returns
The OpcDataTypeDictionary object which is known under the nodeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeDictionary object which is associated with the nodeId specified.
Remarks
It is already assured that the passed nodeId is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type dictionary from a distinct and on-demand determined sequence which combines the OpcDataTypeDictionary objects offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval.
GetType
| Overload | Description |
|---|---|
| GetType( | Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified. |
| GetType( | Retrieves the OpcDataTypeInfo object which is known under the xmlName specified. |
GetType(OpcEncoding)
Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
public OpcDataTypeInfo GetType(OpcEncoding encoding)Public Function [GetType](encoding As OpcEncoding) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
encoding | OpcEncoding | The OpcEncoding which identifies the OpcDataTypeInfo to retrieve. |
Returns
The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The encoding is a null reference ( |
GetType(XmlQualifiedName)
Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.
public OpcDataTypeInfo GetType(XmlQualifiedName xmlName)Public Function [GetType](xmlName As XmlQualifiedName) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
xmlName | XmlQualifiedName | The XmlQualifiedName of the OpcDataTypeInfo object to retrieve. |
Returns
The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).
Exceptions
| Exception | Condition |
|---|---|
| Argument | The xmlName is a null reference ( |
GetTypeCore
| Overload | Description |
|---|---|
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified. |
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which is known under the name specified. |
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which is known under the name specified. |
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified. |
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified. |
| GetTypeCore( | Retrieves the OpcDataTypeInfo object which is known under the xmlName specified. |
GetTypeCore(OpcEncoding)
Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
protected virtual OpcDataTypeInfo GetTypeCore(OpcEncoding encoding)Protected Overridable Function GetTypeCore(
encoding As OpcEncoding) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
encoding | OpcEncoding | The OpcEncoding which identifies the OpcDataTypeInfo to retrieve. |
Returns
The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.
Remarks
It is already assured that the passed encoding is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypeCore(string)
Retrieves the OpcDataTypeInfo object which is known under the name specified.
protected override OpcDataTypeInfo GetTypeCore(string name)Protected Overrides Function GetTypeCore(name As String) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
name | String | The string to use to identify the OpcDataTypeInfo object to retrieve. |
Returns
The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).
Overrides
Remarks
It is already assured that the passed name is not a null reference (Nothing in Visual Basic) nor equals Empty. In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypeCore(OpcName)
Retrieves the OpcDataTypeInfo object which is known under the name specified.
protected override OpcDataTypeInfo GetTypeCore(OpcName name)Protected Overrides Function GetTypeCore(name As OpcName) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName of the OpcDataTypeInfo object to retrieve. |
Returns
The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).
Overrides
Remarks
It is already assured that the passed name is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypeCore(OpcNodeId)
Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
protected override OpcDataTypeInfo GetTypeCore(OpcNodeId typeId)Protected Overrides Function GetTypeCore(typeId As OpcNodeId) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
typeId | OpcNodeId | The OpcNodeId which identifies the OpcDataTypeInfo to retrieve. |
Returns
The OpcDataTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo object which is associated with the typeId specified.
Overrides
Remarks
It is already assured that the passed typeId is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypeCore(Type)
Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
protected override OpcDataTypeInfo GetTypeCore(Type underlyingType)Protected Overrides Function GetTypeCore(
underlyingType As Type) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
underlyingType | Type | The Type which implements the OpcDataTypeInfo to retrieve. |
Returns
The OpcDataTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcDataTypeInfo object associated with the underlyingType specified.
Overrides
Remarks
It is already assured that the passed underlyingType is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypeCore(XmlQualifiedName)
Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.
protected virtual OpcDataTypeInfo GetTypeCore(XmlQualifiedName xmlName)Protected Overridable Function GetTypeCore(
xmlName As XmlQualifiedName) As OpcDataTypeInfoParameters
| Name | Type | Description |
|---|---|---|
xmlName | XmlQualifiedName | The XmlQualifiedName of the OpcDataTypeInfo object to retrieve. |
Returns
The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).
Remarks
It is already assured that the passed xmlName is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects determined from the sequence of dictionaries offered by RetrieveDictionariesCore and RetrieveDictionariesCore. Both methods are called only once and their output is cached for subsequent type dictionary retrieval. These dictionaries are then queried for the type information requested.
GetTypesCore
Retrieves all OpcDataTypeInfo objects offered by the current OpcDataTypeSystem .
protected override OpcDataTypeInfo[] GetTypesCore()Protected Overrides Function GetTypesCore() As OpcDataTypeInfo()Returns
An array that contains all OpcDataTypeInfo objects that are offered by the OpcDataTypeSystem.
Overrides
Of
Retrieves the type system used for the encodingType specified which provides encoded type information offered by the Client or Server application.
public static OpcDataTypeSystem Of(OpcEncodingType encodingType)Public Shared Function [Of](
encodingType As OpcEncodingType) As OpcDataTypeSystemParameters
| Name | Type | Description |
|---|---|---|
encodingType | OpcEncodingType | One of the members defined by the OpcEncodingType enumeration which identifies the type system to retrieve. |
Returns
An instance of the OpcDataTypeSystem class which contains the type dictionaries described by the Types using the OpcDataTypeEncodingAttribute with the OpcEncodingType specified by encodingType and implemented in the application which uses the OPC UA SDK.
RetrieveDictionariesCore
| Overload | Description |
|---|---|
| Retrieve | Retrieves all Opc |
| Retrieve | When implemented in a derived class, retrieves all Opcknown specified. |
RetrieveDictionariesCore()
Retrieves all OpcDataTypeDictionary objects explictly offered by the OpcDataTypeSystem.
protected IList<OpcDataTypeDictionary> RetrieveDictionariesCore()Protected Function RetrieveDictionariesCore() As IList(Of OpcDataTypeDictionary)Returns
A list of explictly offered OpcDataTypeDictionary objects.
RetrieveDictionariesCore(IList<OpcDataTypeDictionary>)
When implemented in a derived class, retrieves all OpcDataTypeDictionary objects on-demand offered by the OpcDataTypeSystem except the already knownDictionaries specified.
protected virtual IEnumerable<OpcDataTypeDictionary> RetrieveDictionariesCore(
IList<OpcDataTypeDictionary> knownDictionaries)Protected Overridable Function RetrieveDictionariesCore(
knownDictionaries As IList(Of OpcDataTypeDictionary)) As IEnumerable(Of OpcDataTypeDictionary)Parameters
| Name | Type | Description |
|---|---|---|
known | IList<Opc | The list of already known Opc |
Returns
IEnumerable<OpcDataTypeDictionary>
A sequence of OpcDataTypeDictionary objects offered by the OpcDataTypeSystem except the type dictionaries in knownDictionaries.
ToString
Returns a string representing the Name of the current OpcDataTypeSystem.
public override string ToString()Public Overrides Function ToString() As StringReturns
A string representing the Name of the current OpcDataTypeSystem.
Overrides

