Base class for dictionary readers. More...

#include <uaabstractdictionaryreader.h>

Inherited by UaClientSdk::UaDictionaryReader, and UaDictionaryReaderServer.

Public Member Functions
UaStatus	readDictionaries (bool bReadNs0, const UaStringArray &namespaceArray, std::map< UaQualifiedName, UaStructureDefinition > &mapStructures, std::map< UaQualifiedName, UaEnumDefinition > &mapEnums)
	Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary. More...

UaStatus	readDictionaries (bool bReadNs0, const UaStringArray &namespaceArray, std::map< UaQualifiedName, UaStructureDefinition > &mapStructures, std::map< UaQualifiedName, UaEnumDefinition > &mapEnums, std::vector< UaOptionSetDefinition > &optionSets)
	Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary. More...

UaStatus	readDictionaries (bool bReadNs0, std::map< UaQualifiedName, UaStructureDefinition > &mapStructures, std::map< UaQualifiedName, UaEnumDefinition > &mapEnums)
	Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary. More...

UaStatus	readDictionaries (bool bReadNs0, std::map< UaQualifiedName, UaStructureDefinition > &mapStructures, std::map< UaQualifiedName, UaEnumDefinition > &mapEnums, std::vector< UaOptionSetDefinition > &optionSets)
	Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary. More...

Protected Member Functions
virtual UaStatus	browse (const UaNodeId &startingNodeId, const UaNodeId &referenceTypeId, UaReferenceDescriptions &rResults) const =0
	Discover forward references of a specified node. More...

virtual UaStatus	browseList (const UaBrowseDescriptions &browseDescriptions, UaBrowseResults &rDescriptions) const
	Uses browse in implementation. More...

virtual UaStatus	browseList (const UaNodeIdArray &startingNodeIds, const UaNodeId &referenceTypeId, UaReferenceDescriptions &rResults) const
	Uses browse in implementation. More...

virtual UaStatus	translate (const UaNodeId &startingNodeId, const UaQualifiedName &browseName, const UaNodeId &referenceTypeId, UaNodeId &targetNodeId) const
	Uses browse in implementation. More...

virtual UaStatus	translateBrowsePaths (const UaNodeIdArray &startingNodeIds, const UaNodeId &referenceTypeId, const UaQualifiedName &browseName, UaBrowsePathResults &targetNodes) const
	Uses translate in implementation. More...

virtual UaStatus	translateBrowsePaths (const UaReferenceDescriptions &startingNodes, const UaNodeId &referenceTypeId, const UaQualifiedName &browseName, UaBrowsePathResults &targetNodes) const
	Uses translate in implementation. More...

Detailed Description

Base class for dictionary readers.

Reads the values of dictionary nodes and parses these values. Browses the address space to find DataType NodeIds and encoding NodeIds.

This class can be inherited on client or server side. This base class provides some abstract methods that must be implemented.

Member Function Documentation

virtual UaStatus UaAbstractDictionaryReader::browse	(	const UaNodeId &	startingNodeId,
		const UaNodeId &	referenceTypeId,
		UaReferenceDescriptions &	rResults
	)		const

protectedpure virtual

Discover forward references of a specified node.

This method is used to return a list of references and target nodes for the passed node to browse.

Parameters

startingNodeId	The NodeId of the node to browse.
referenceTypeId	Only references using this ReferenceType (or one of its subtypes) are returned
rResults	The list of references and target nodes

UaStatus UaAbstractDictionaryReader::browseList	(	const UaBrowseDescriptions &	browseDescriptions,
		UaBrowseResults &	rBrowseResults
	)		const

protectedvirtual

Uses browse in implementation.

To get a better performance you should override this method.

UaStatus UaAbstractDictionaryReader::browseList	(	const UaNodeIdArray &	startingNodeIds,
		const UaNodeId &	referenceTypeId,
		UaReferenceDescriptions &	rResults
	)		const

protectedvirtual

Uses browse in implementation.

To get a better performance you should override this method.

UaStatus UaAbstractDictionaryReader::readDictionaries	(	bool	bReadNs0,
		const UaStringArray &	namespaceArray,
		std::map< UaQualifiedName, UaStructureDefinition > &	mapStructures,
		std::map< UaQualifiedName, UaEnumDefinition > &	mapEnums
	)

Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary.

Parameters

bReadNs0	If true, the DataTypeDictionary Opc.Ua is read and parsed. Otherwise the definitions are added by the SDK.
namespaceArray	The current namespace array
mapStructures	The returned UaStructureDefinitions. Structures with invalid DataTypeIds or invalid binary encoding ids are ignored.
mapEnums	The returned UaEnumDefinition. Enumerations with invalid DataTypeIds are ignored. Enumerations that are not part of a dictionary but are exposed in the address space are added.

UaStatus UaAbstractDictionaryReader::readDictionaries	(	bool	bReadNs0,
		const UaStringArray &	namespaceArray,
		std::map< UaQualifiedName, UaStructureDefinition > &	mapStructures,
		std::map< UaQualifiedName, UaEnumDefinition > &	mapEnums,
		std::vector< UaOptionSetDefinition > &	optionSets
	)

Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary.

Parameters

bReadNs0	If true, the DataTypeDictionary Opc.Ua is read and parsed. Otherwise the definitions are added by the SDK.
namespaceArray	The current namespace array
mapStructures	The returned UaStructureDefinitions. Structures with invalid DataTypeIds or invalid binary encoding ids are ignored.
mapEnums	The returned UaEnumDefinition. Enumerations with invalid DataTypeIds are ignored. Enumerations that are not part of a dictionary but are exposed in the address space are added.
optionSets	The returned UaOptionSetDefinitions. OptionSets with invalid DataTypeIds or invalid OptionSetValues properties are ignored.

UaStatus UaAbstractDictionaryReader::readDictionaries	(	bool	bReadNs0,
		std::map< UaQualifiedName, UaStructureDefinition > &	mapStructures,
		std::map< UaQualifiedName, UaEnumDefinition > &	mapEnums
	)

Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary.

Parameters

bReadNs0	If true, the DataTypeDictionary Opc.Ua is read and parsed. Otherwise the definitions are added by the SDK.
mapStructures	The returned UaStructureDefinitions. Structures with invalid DataTypeIds or invalid binary encoding ids are ignored.
mapEnums	The returned UaEnumDefinition. Enumerations with invalid DataTypeIds are ignored. Enumerations that are not part of a dictionary but are exposed in the address space are added.

UaStatus UaAbstractDictionaryReader::readDictionaries	(	bool	bReadNs0,
		std::map< UaQualifiedName, UaStructureDefinition > &	mapStructures,
		std::map< UaQualifiedName, UaEnumDefinition > &	mapEnums,
		std::vector< UaOptionSetDefinition > &	optionSets
	)

Reads the DataTypeDictionaries that are part of the DataTypeSystem OPC Binary.

Parameters

bReadNs0	If true, the DataTypeDictionary Opc.Ua is read and parsed. Otherwise the definitions are added by the SDK.
mapStructures	The returned UaStructureDefinitions. Structures with invalid DataTypeIds or invalid binary encoding ids are ignored.
mapEnums	The returned UaEnumDefinition. Enumerations with invalid DataTypeIds are ignored. Enumerations that are not part of a dictionary but are exposed in the address space are added.
optionSets	The returned UaOptionSetDefinitions. OptionSets with invalid DataTypeIds or invalid OptionSetValues properties are ignored.

UaStatus UaAbstractDictionaryReader::translate	(	const UaNodeId &	startingNodeId,
		const UaQualifiedName &	browseName,
		const UaNodeId &	referenceTypeId,
		UaNodeId &	targetNodeId
	)		const

protectedvirtual

Uses browse in implementation.

To get a better performance you should override this method.

UaStatus UaAbstractDictionaryReader::translateBrowsePaths	(	const UaNodeIdArray &	startingNodeIds,
		const UaNodeId &	referenceTypeId,
		const UaQualifiedName &	browseName,
		UaBrowsePathResults &	targetNodes
	)		const

protectedvirtual

Uses translate in implementation.

To get a better performance you should override this method.

UaStatus UaAbstractDictionaryReader::translateBrowsePaths	(	const UaReferenceDescriptions &	startingNodes,
		const UaNodeId &	referenceTypeId,
		const UaQualifiedName &	browseName,
		UaBrowsePathResults &	targetNodes
	)		const

protectedvirtual

Uses translate in implementation.

To get a better performance you should override this method.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uaabstractdictionaryreader.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uaabstractdictionaryreader.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation