The class NodeMap represents a collection of Node objects based on the underlying XML definition file. This class supports two representation forms, a unstructured list and a tree structure.
More...
#include <bgapi2_genicam.hpp>
|
class | iterator |
| This class provides a iterator that can read or modify any element in the list. More...
|
|
The class NodeMap represents a collection of Node objects based on the underlying XML definition file. This class supports two representation forms, a unstructured list and a tree structure.
The tree structure is a hierarchical representation. Special kinds of nodes can have subordinate nodes. These nodes are from interface type 'ICategory' (see function Node::GetInterface). The access to its subordinate nodes occurs by calling NodeMap::GetNodeTree. The unstructured list representation is linear. Use the NodeMap::iterator class and the NodeMap::begin and NodeMap::end functions for iterating through the list. All nodes from type 'ICategory' are removed and all its subordinate nodes are moved into the single list. The following functions use the unstructured list representation: INode::GetNodeList, Device::GetRemoteNodeList, Node::GetNodeList, Node::GetEnumNodeList, Node::GetSelectedNodeList The following functions use the tree structure representation: INode::GetNodeTree, Device::GetRemoteNodeTree, Node::GetNodeTree
Definition at line 1573 of file bgapi2_genicam.hpp.
◆ begin()
BGAPI2::NodeMap::begin |
( |
| ) |
|
This function delivers an iterator on the top of the Node list.
- Returns
- iterator The iterator on the top of the Node list.
◆ end()
This function delivers an iterator at the end of the Node list.
- Returns
- iterator The iterator at the end of the Node list.
◆ find()
BGAPI2::NodeMap::find |
( |
const String & |
_keyval | ) |
|
This function delivers an iterator on an object to be found. The object is not found, this functions delivers an end-iterator.
- Parameters
-
_keyval | The ID to the object to be found. |
- Returns
- iterator The iterator to the found object.
◆ GetNode()
BGAPI2::NodeMap::GetNode |
( |
String |
name | ) |
|
This function delivers a certain object of the Node list.
- Parameters
-
name | For this name, the associated Node object is delivered. |
- Returns
- Node* The requested Node object.
- Exceptions
-
◆ GetNodeByIndex()
BGAPI2::NodeMap::GetNodeByIndex |
( |
bo_uint64 |
iIndex | ) |
|
This function delivers a pointer to a specified Node object.
- Parameters
-
iIndex | The index of the Node object. |
- Returns
- Node* The requested Node object.
- Exceptions
-
◆ GetNodeCount()
BGAPI2::NodeMap::GetNodeCount |
( |
| ) |
|
This function delivers the number of Node objects in the Node list.
- Returns
- bo_uint64 The number of Node objects in the Node list.
◆ GetNodePresent()
BGAPI2::NodeMap::GetNodePresent |
( |
String |
name | ) |
|
This function delivers a flag that indicates whether the NodeMap contains a Node with the specified name.
- Parameters
-
name | The Node name to search for. |
- Returns
- bo_bool The flag which indicates whether the NodeMap contains a Node with the specified name.
◆ operator[]()
BGAPI2::NodeMap::operator[] |
( |
const String & |
val | ) |
|
This operator allows the direct access to an object of the Node list.
- Parameters
-
val | For this name, the associated Node object is delivered. |
- Returns
- Node* The requested Node object.
- Exceptions
-
◆ size()
BGAPI2::NodeMap::size |
( |
| ) |
|
This function delivers the number of Node objects in the Node list.
- Returns
- bo_uint64 The number of Node objects in the Node list.
The documentation for this class was generated from the following file: