Reference

OpcDataTypeDictionary Members

Type

OpcDataTypeDictionary

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

ByteOrder

virtual

Gets the default byte order of the data types defined in this OpcDataTypeDictionary.

public virtual OpcByteOrder? ByteOrder { get; }

Public Overridable ReadOnly Property ByteOrder As OpcByteOrder?

Property value

Nullable<OpcByteOrder>

One of the members defined by the OpcByteOrder enumeration or a null reference (Nothing in Visual Basic) in case there the dictionary does not declare a specific byte order to use.

Documentation

virtual · since v2.9

Gets any semantic information that would help a human to understand what the type dictionary defines.

public virtual string Documentation { get; }

Public Overridable ReadOnly Property Documentation As String

Property value

String

A human readable text that describes the type dictionary and that would help a human to understand what the type dictionary defines.

Empty

static

Gets the type dictionary to use if their is no specific type dictionary data available.

public static OpcDataTypeDictionary Empty { get; }

Public Shared ReadOnly Property Empty As OpcDataTypeDictionary

Property value

OpcDataTypeDictionary

An instance of the OpcDataTypeDictionary class which refers to the Empty.

EmptyType

Gets the type to use if their is no specific type data available, but the empty type shall refer to the current OpcDataTypeDictionary.

public OpcDataTypeInfo EmptyType { get; }

Public ReadOnly Property EmptyType As OpcDataTypeInfo

Property value

OpcDataTypeInfo

An instance of the OpcDataTypeInfo class which refers to the current OpcDataTypeDictionary.

EncodingType

Gets the type of encoding used for the data types defined in the current OpcDataTypeDictionary.

public OpcEncodingType EncodingType { get; }

Public ReadOnly Property EncodingType As OpcEncodingType

Property value

OpcEncodingType

One of the members defined by the OpcEncodingType enumeration.

HasCachedTypes

protected

Gets a value indicating whether the type dictionary already has determined at least some type information offered as OpcDataTypeInfo objects.

protected bool HasCachedTypes { get; }

Protected ReadOnly Property HasCachedTypes As Boolean

Property value

Boolean

The value true if the dictionary offers already prepared OpcDataTypeInfo objects; otherwise the value false.

HasCachingCompleted

protected · virtual

Gets a value indicating whether the type dictionary has determined the whole type information offered as OpcDataTypeInfo objects.

protected virtual bool HasCachingCompleted { get; }

Protected Overridable Property HasCachingCompleted As Boolean

Property value

Boolean

The value true if the dictionary has completed its type information retrieval and will use its internal cache to determine OpcDataTypeInfo objects; otherwise the value false.

IsEmpty

virtual

Gets a value indicating whether the current OpcDataTypeDictionary represents a type dictionary to use if there is no specific type dictionary described.

public virtual bool IsEmpty { get; }

Public Overridable ReadOnly Property IsEmpty As Boolean

Property value

Boolean

The value true if the type dictionary does not declare a specific type dictionary; otherwise the value false.

Name

Gets a value which defines the non-localizable human-readable name of the type dictionary represented. A node which represents this OpcDataTypeDictionary uses the Name as its BrowseName.

public OpcName Name { get; }

Public ReadOnly Property Name As OpcName

Property value

OpcName

An instance of the OpcName class with the string used as the name of the type dictionary which does not unambiguously identify the OpcDataTypeDictionary.

Namespace

Gets the namespace within the type dictionary has been declared.

public OpcNamespace Namespace { get; }

Public ReadOnly Property [Namespace] As OpcNamespace

Property value

OpcNamespace

An instance of the OpcNamespace class which provides the information about the namespace within the current OpcDataTypeDictionary defines its type data.

NodeId

Gets a value which identifies the type dictionary represented. A node which represents this OpcDataTypeDictionary uses the NodeId as its NodeId.

public OpcNodeId NodeId { get; }

Public ReadOnly Property NodeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId class used as the identifier of the type dictionary which unambiguously identifies the OpcDataTypeDictionary.

TypeSystem

Gets the the OpcDataTypeSystem which conains the data dictionary represented.

public OpcDataTypeSystem TypeSystem { get; }

Public ReadOnly Property TypeSystem As OpcDataTypeSystem

Property value

OpcDataTypeSystem

An instance of the OpcDataTypeSystem class which defines the current OpcDataTypeDictionary.

XmlNamespace

virtual

Gets the Namespace used in the XML-based declaration of the type dictionary.

public virtual string XmlNamespace { get; }

Public Overridable ReadOnly Property XmlNamespace As String

Property value

String

A string which represents the Namespace used in the XML-based declaration of the type dictionary.

Methods

GetType

6 overloads

Overload	Description
GetType(OpcEncoding)	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
GetType(string)	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetType(OpcName)	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetType(OpcNodeId)	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
GetType(Type)	Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
GetType(XmlQualifiedName)	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 OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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
ArgumentNullException	The encoding is a null reference (Nothing in Visual Basic).

GetType(string)

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetType(string name)

Public Function [GetType](name As String) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetType(OpcName)

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetType(OpcName name)

Public Function [GetType](name As OpcName) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetType(OpcNodeId)

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

public OpcDataTypeInfo GetType(OpcNodeId typeId)

Public Function [GetType](typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetType(Type)

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcDataTypeInfo GetType(Type underlyingType)

Public Function [GetType](underlyingType As Type) As OpcDataTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

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 OpcDataTypeInfo

Parameters

Name	Type	Description
xmlName	XmlQualifiedName	The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The xmlName is a null reference (Nothing in Visual Basic).

GetTypeCore

protected · virtual · 6 overloads

Overload	Description
GetTypeCore(OpcEncoding)protected · virtual	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
GetTypeCore(string)protected · virtual	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetTypeCore(OpcName)protected · virtual	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetTypeCore(OpcNodeId)protected · virtual	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
GetTypeCore(Type)protected · virtual	Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
GetTypeCore(XmlQualifiedName)protected · virtual	Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

GetTypeCore(OpcEncoding)

protected · virtual

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 OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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 offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(string)

protected · virtual

Retrieves the OpcDataTypeInfo object which is known under the name specified.

protected virtual OpcDataTypeInfo GetTypeCore(string name)

Protected Overridable Function GetTypeCore(name As String) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) 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) 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 offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(OpcName)

protected · virtual

Retrieves the OpcDataTypeInfo object which is known under the name specified.

protected virtual OpcDataTypeInfo GetTypeCore(OpcName name)

Protected Overridable Function GetTypeCore(name As OpcName) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo 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 from a distinct and on-demand determined sequence which combines the OpcDataTypeInfo objects offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(OpcNodeId)

protected · virtual

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

protected virtual OpcDataTypeInfo GetTypeCore(OpcNodeId typeId)

Protected Overridable Function GetTypeCore(
    typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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.

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 offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(Type)

protected · virtual

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

protected virtual OpcDataTypeInfo GetTypeCore(Type underlyingType)

Protected Overridable Function GetTypeCore(
    underlyingType As Type) As OpcDataTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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.

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 offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(XmlQualifiedName)

protected · virtual

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 OpcDataTypeInfo

Parameters

Name	Type	Description
xmlName	XmlQualifiedName	The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

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 offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypes

Retrieves all OpcDataTypeInfo objects offered by the OpcDataTypeDictionary.

public OpcDataTypeInfo[] GetTypes()

Public Function GetTypes() As OpcDataTypeInfo()

Returns

OpcDataTypeInfo[]

An array that contains all OpcDataTypeInfo objects that are offered by the OpcDataTypeDictionary.

GetXmlNamespace

static

Determines the namespace information used to initialize XmlQualifiedName instances to identify OpcDataTypeInfo objects using a full qualified name.

public static string GetXmlNamespace(OpcNamespace @namespace)

Public Shared Function [GetXmlNamespace]([namespace] As OpcNamespace) As String

Parameters

Name	Type	Description
namespace	OpcNamespace	The OpcNamespace to use to determine the namespace information used for XmlQualifiedName instances.

Returns

String

A string representing the used Namespace in the context of the namespace specified.

Load

static · 2 overloads · since v2.23

Overload	Description
Load(string)static · since v2.23	Creates a new OpcDataTypeDictionary instance from the file specified by filePath.
Load(Stream)static · since v2.23	Creates a new OpcDataTypeDictionary instance from the contents in the stream specified.

Load(string)

static · since v2.23

Creates a new OpcDataTypeDictionary instance from the file specified by filePath.

public static OpcDataTypeDictionary Load(string filePath)

Public Shared Function Load(filePath As String) As OpcDataTypeDictionary

Parameters

Name	Type	Description
filePath	String	The path to the file from which the OpcDataTypeDictionary is to be created.

Returns

OpcDataTypeDictionary

A new instance of the OpcDataTypeDictionary class that represents the contents of the file.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The filePath is a null reference (Nothing in Visual Basic).

Load(Stream)

static · since v2.23

Creates a new OpcDataTypeDictionary instance from the contents in the stream specified.

public static OpcDataTypeDictionary Load(Stream stream)

Public Shared Function Load(stream As Stream) As OpcDataTypeDictionary

Parameters

Name	Type	Description
stream	Stream	The Stream which contains the data from which the OpcDataTypeDictionary is to be created.

Returns

OpcDataTypeDictionary

A new instance of the OpcDataTypeDictionary class that represents the contents of the stream.

Exceptions

Exception	Condition
ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).

Parse

static · since v2.23

Creates a new OpcDataTypeDictionary instance from the string specified by data.

public static OpcDataTypeDictionary Parse(string data)

Public Shared Function Parse(data As String) As OpcDataTypeDictionary

Parameters

Name	Type	Description
data	String	The string that contains the data type dictionary data.

Returns

OpcDataTypeDictionary

Exceptions

Exception	Condition
ArgumentException	The data is an empty string.
ArgumentNullException	The data is a null reference (Nothing in Visual Basic).

RetrieveTypesCore

protected · 2 overloads · since v2.9

Overload	Description
RetrieveTypesCore()protected · since v2.9	Retrieves all OpcDataTypeInfo objects explictly offered by the OpcDataTypeDictionary.
RetrieveTypesCore(IDictionary<XmlQualifiedName, OpcDataTypeInfo>)protected · virtual · since v2.9	When implemented in a derived class, retrieves all OpcDataTypeInfo objects on-demand offered by the OpcDataTypeDictionary except the already knownTypes specified.

RetrieveTypesCore()

protected · since v2.9

Retrieves all OpcDataTypeInfo objects explictly offered by the OpcDataTypeDictionary.

protected IDictionary<XmlQualifiedName, OpcDataTypeInfo> RetrieveTypesCore()

Protected Function RetrieveTypesCore() As IDictionary(Of XmlQualifiedName, OpcDataTypeInfo)

Returns

IDictionary<XmlQualifiedName, OpcDataTypeInfo>

A dictionary of explictly offered OpcDataTypeInfo objects.

RetrieveTypesCore(IDictionary<XmlQualifiedName, OpcDataTypeInfo>)

protected · virtual · since v2.9

When implemented in a derived class, retrieves all OpcDataTypeInfo objects on-demand offered by the OpcDataTypeDictionary except the already knownTypes specified.

protected virtual IEnumerable<OpcDataTypeInfo> RetrieveTypesCore(
    IDictionary<XmlQualifiedName, OpcDataTypeInfo> knownTypes)

Protected Overridable Function RetrieveTypesCore(
    knownTypes As IDictionary(Of XmlQualifiedName, OpcDataTypeInfo)) As IEnumerable(Of OpcDataTypeInfo)

Parameters

Name	Type	Description
knownTypes	IDictionary<XmlQualifiedName, OpcDataTypeInfo>	The dictionary of already known OpcDataTypeInfo objects which shall not be offered.

Returns

IEnumerable<OpcDataTypeInfo>

A sequence of OpcDataTypeInfo objects offered by the OpcDataTypeDictionary except the types in knownTypes.

ToString

override

Returns a string representing the Name and the Namespace of the current OpcDataTypeDictionary.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string representing the Name and the Namespace of the current OpcDataTypeDictionary.

Overrides

ToString()

TryParse

static · since v2.23

Determines whether a string is a valid OpcDataTypeDictionary.

public static bool TryParse(string data, out OpcDataTypeDictionary dictionary)

Public Shared Function TryParse(
    data As String,
    dictionary As OpcDataTypeDictionary) As Boolean

Parameters

Name	Type	Description
data	String	The string to validate.
dictionary	out OpcDataTypeDictionary	The OpcDataTypeDictionary version of the string.

Returns

Boolean

The value true if the specified data is a valid OpcDataTypeDictionary; otherwise the value false.