C++ Based OPC UA Client/Server SDK  1.5.5.355
TypeDictionariesAccess Class Reference

Class for adding and accessing DataType Definitions. More...

#include <typedictionaries.h>

Inherits UaDataTypeDictionary.

Inherited by TypeDictionaries.

Public Member Functions

 TypeDictionariesAccess (const UaString &sNamespaceUri)
 Construction. More...
 
virtual ~TypeDictionariesAccess ()
 Destructor.
 
void addStructuredTypeDefinition (const UaStructureDefinition &structure)
 Adds a new structured DataType without adding nodes. More...
 
void addEnumeratedTypeDefinition (const UaEnumDefinition &enumeration)
 Adds a new enumerated DataType without adding nodes. More...
 
virtual
UaDataTypeDictionary::DefinitionType 
definitionType (const UaNodeId &dataTypeId)
 Returns the DefinitionType for the specified data type. More...
 
virtual UaEnumDefinition enumDefinition (const UaNodeId &dataTypeId)
 Returns the UaEnumDefinition for the specified data type. More...
 
virtual UaStructureDefinition structureDefinition (const UaNodeId &dataTypeId)
 Returns the UaStructureDefinition for the specified data type. More...
 
virtual UaOptionSetDefinition optionSetDefinition (const UaNodeId &dataTypeId)
 Returns the UaOptionSetDefinition for the specified data type. More...
 
- Public Member Functions inherited from UaDataTypeDictionary
DefinitionType definitionType (const UaVariant &vValue)
 Returns the UaDataTypeDictionary::DefinitionType of a variant. More...
 
DefinitionType definitionType (const UaExtensionObject &vValue)
 Returns the UaDataTypeDictionary::DefinitionType of an ExtensionObject. More...
 
UaStructureDefinition structureDefinition (const UaVariant &vValue)
 Returns the UaStructureDefinition of a variant. More...
 
UaStructureDefinition structureDefinition (const UaExtensionObject &vValue)
 Returns the UaStructureDefinition of an ExtensionObject. More...
 

Additional Inherited Members

- Public Types inherited from UaDataTypeDictionary
enum  DefinitionType
 Enumeration that indicates whether a UaEnumDefinition or a UaStructureDefinition is available.
 

Detailed Description

Class for adding and accessing DataType Definitions.

Using this class DataType nodes cannot be added.

Constructor & Destructor Documentation

TypeDictionariesAccess::TypeDictionariesAccess ( const UaString sNamespaceUri)

Construction.

Parameters
sNamespaceUriThe namespace used as value for the NamespaceUri of the dictionary

Member Function Documentation

void TypeDictionariesAccess::addEnumeratedTypeDefinition ( const UaEnumDefinition enumeration)

Adds a new enumerated DataType without adding nodes.

Updates the DataTypeDictionary if the compiler flag SUPPORT_XML_PARSER is set to 1. The method addTypeDictionary must be called before calling this method.

Parameters
enumerationThe NamespaceIndex of the DataType must be equal to the NamespaceIndex of the NodeConfig.
void TypeDictionariesAccess::addStructuredTypeDefinition ( const UaStructureDefinition structure)

Adds a new structured DataType without adding nodes.

Updates the DataTypeDictionary if the compiler flag SUPPORT_XML_PARSER is set to 1. The method addTypeDictionary or setTYpeDictionary must be called before calling this method.

Parameters
structureThe NamespaceIndex of the DataType and the BinaryEncodingId must be equal to the NamespaceIndex of the NodeConfig.
UaDataTypeDictionary::DefinitionType TypeDictionariesAccess::definitionType ( const UaNodeId dataTypeId)
virtual

Returns the DefinitionType for the specified data type.

Is called by definitionType(const UaVariant &vValue) and definitionType(const UaExtensionObject &vValue).

Implements UaDataTypeDictionary.

UaEnumDefinition TypeDictionariesAccess::enumDefinition ( const UaNodeId dataTypeId)
virtual

Returns the UaEnumDefinition for the specified data type.

Implements UaDataTypeDictionary.

UaOptionSetDefinition TypeDictionariesAccess::optionSetDefinition ( const UaNodeId dataTypeId)
virtual

Returns the UaOptionSetDefinition for the specified data type.

Implements UaDataTypeDictionary.

UaStructureDefinition TypeDictionariesAccess::structureDefinition ( const UaNodeId dataTypeId)
virtual

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