UaRelativePath Class Reference
This class is used to manage 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.
More...
#include <opcuatypes.h>
List of all members.
Detailed Description
This class is used to manage 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.
UaRelativePath
Constructor & Destructor Documentation
| UaRelativePath::UaRelativePath |
( |
const OpcUa_RelativePath & |
relativePath |
) |
|
| UaRelativePath::~UaRelativePath |
( |
|
) |
[virtual] |
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.
| 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 sucesscully processing the current position.
- See also:
- getCurrentElement
| OpcUa_UInt32 UaRelativePath::pathElementCount |
( |
|
) |
[inline] |
Get the total number of relative path elements in the list.
- Returns:
- The number of elements.
| const OpcUa_RelativePathElement * UaRelativePath::getCurrentElement |
( |
|
) |
|
Get the current Element.
- Returns:
- the realtive Path of the current Element.
The documentation for this class was generated from the following files:
- src/uaserver/uaservercpp/coremodule/opcuatypes.h
- src/uaserver/uaservercpp/coremodule/opcuatypes.cpp
