Functions related to the GenICam NodeMap or FeatureMap. More...
Typedefs | |
typedef struct BGAPI2_NodeMap | BGAPI2_NodeMap |
Struct for pointers of type NodeMap. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_NodeMap_GetNode (BGAPI2_NodeMap *node_map, const char *name, BGAPI2_Node **node) |
Gets the named node of given map. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_NodeMap_GetNodeCount (BGAPI2_NodeMap *node_map, bo_uint64 *count) |
Returns the number of nodes in nodemap. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_NodeMap_GetNodeByIndex (BGAPI2_NodeMap *node_map, bo_uint64 index, BGAPI2_Node **node) |
Returns the node with the index. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_NodeMap_GetNodePresent (BGAPI2_NodeMap *node_map, const char *name, bo_bool *is_present) |
Checks if node is present in nodemap. More... | |
Detailed Description
Functions related to the GenICam NodeMap or FeatureMap.
Typedef Documentation
◆ BGAPI2_NodeMap
typedef struct BGAPI2_NodeMap BGAPI2_NodeMap |
Struct for pointers of type NodeMap.
Function Documentation
◆ BGAPI2_NodeMap_GetNode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNode | ( | BGAPI2_NodeMap * | node_map, |
const char * | name, | ||
BGAPI2_Node ** | node | ||
) |
Gets the named node of given map.
- Parameters
-
[in] node_map Pointer to the nodemap [in] name Node name [out] node Pointer to store the node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_NodeMap_GetNodeCount()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodeCount | ( | BGAPI2_NodeMap * | node_map, |
bo_uint64 * | count | ||
) |
Returns the number of nodes in nodemap.
- Parameters
-
[in] node_map Pointer to the nodemap [out] count Pointer to store the node count
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_NodeMap_GetNodeByIndex()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodeByIndex | ( | BGAPI2_NodeMap * | node_map, |
bo_uint64 | index, | ||
BGAPI2_Node ** | node | ||
) |
Returns the node with the index.
- Parameters
-
[in] node_map Pointer to the nodemap [in] index Index of the node [out] node Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error, node with iIndex not found BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_NodeMap_GetNodePresent()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_NodeMap_GetNodePresent | ( | BGAPI2_NodeMap * | node_map, |
const char * | name, | ||
bo_bool * | is_present | ||
) |
Checks if node is present in nodemap.
- Parameters
-
[in] node_map Pointer to the nodemap [in] name Name of node [out] is_present Pointer to store the result
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters