UaRelativePath Class Reference

This class manages a relative path used for TranslatBrowsePathsToNodeIds. More...

#include <opcuatypes.h>

Public Member Functions
	UaRelativePath (const OpcUa_RelativePath &relativePath)
	construction
virtual	~UaRelativePath ()
	destruction
OpcUa_UInt32	currentPosition ()
	Get the current position in the list of browse elements. More...
void	incrementPosition ()
	Increments the position in the list of relative path element to the next element to process. More...
OpcUa_UInt32	pathElementCount () const
	Get the total number of relative path elements in the list. More...
const OpcUa_RelativePathElement *	pathElements () const
	Get a pointer to the list of relative path elements. More...
const OpcUa_RelativePathElement *	getCurrentElement ()
	Get a pointer to the next relative path element structure to process. More...

Detailed Description

This class manages a relative path used for TranslatBrowsePathsToNodeIds.

The relative path contains a list of path elements where each path element contains the reference type to follow and the browse name of the target node. This path is used to find a target node by starting at a starting node and by following the path. This class manages the relative path and the current position in the path. To process the path a pointer to the current path element can be requested by using the function getCurrentElement(). If the current position contained a valid reference and browse path and a matching node was found at this level, the position must be incremented by calling incrementPosition() and the next level must be processed until the end of the list is reached. It is not possible to create plane copies of this Class.

Member Function Documentation

OpcUa_UInt32 UaRelativePath::currentPosition ( )

inline

Get the current position in the list of browse elements.

Returns

The current position in the list of browse elements as zero based index.

const OpcUa_RelativePathElement * UaRelativePath::getCurrentElement

(

)

Get a pointer to the next relative path element structure to process.

This function returns a null pointer if the end of the list is reached.

Returns

the relative Path of the current Element.

void UaRelativePath::incrementPosition ( )

inline

Increments the position in the list of relative path element to the next element to process.

This function must be called after successfully processing the current position.

See Also

getCurrentElement

OpcUa_UInt32 UaRelativePath::pathElementCount ( ) const

inline

Get the total number of relative path elements in the list.

Returns

The number of elements.

const OpcUa_RelativePathElement* UaRelativePath::pathElements ( ) const

inline

Get a pointer to the list of relative path elements.

Returns

The list of relative path elements.

---

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

• D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcuatypes.h
• D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcuatypes.cpp