ItalaApiC  1.3.3
Functions

Functions

ITALA_API_C ItalaError NODEMAP_GetNode (H_NODEMAP hNodeMap, const char *nodeName, H_NODE *phNode)
 
ITALA_API_C ItalaError NODEMAP_GetNumNodes (H_NODEMAP hNodeMap, size_t *pNumNodes)
 
ITALA_API_C ItalaError NODEMAP_GetNodeByIndex (H_NODEMAP hNodeMap, size_t index, H_NODE *phNode)
 
ITALA_API_C ItalaError NODEMAP_InvalidateNodes (H_NODEMAP hNodeMap)
 
ITALA_API_C ItalaError NODEMAP_GetDeviceName (H_NODEMAP hNodeMap, char *deviceName, size_t *pSize)
 
ITALA_API_C ItalaError NODEMAP_Poll (H_NODEMAP hNodeMap, int64_t elapsedTime)
 

Detailed Description

All the methods related to nodemap managed by GenApi.

Function Documentation

◆ NODEMAP_GetNode()

ITALA_API_C ItalaError NODEMAP_GetNode ( H_NODEMAP  hNodeMap,
const char *  nodeName,
H_NODE *  phNode 
)

Get a node by its name.

Parameters
[in]hNodeMapHandle to NodeMap instance.
[in]nodeNameName of the node to retrieve.
[out]phNodeHandle to Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODEMAP_GetNumNodes()

ITALA_API_C ItalaError NODEMAP_GetNumNodes ( H_NODEMAP  hNodeMap,
size_t *  pNumNodes 
)

Get number of nodes in the nodemap.

Parameters
[in]hNodeMapHandle to NodeMap instance.
[out]pNumNodesNumber of nodes.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODEMAP_GetNodeByIndex()

ITALA_API_C ItalaError NODEMAP_GetNodeByIndex ( H_NODEMAP  hNodeMap,
size_t  index,
H_NODE *  phNode 
)

Get a node handler, given the specific index.

Parameters
[in]hNodeMapHandle to NodeMap instance.
[in]indexIndex of Node.
[out]phNodeHandle to Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODEMAP_InvalidateNodes()

ITALA_API_C ItalaError NODEMAP_InvalidateNodes ( H_NODEMAP  hNodeMap)

Invalidate all the node of the nodemap.

Parameters
[in]hNodeMapHandle to NodeMap instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODEMAP_GetDeviceName()

ITALA_API_C ItalaError NODEMAP_GetDeviceName ( H_NODEMAP  hNodeMap,
char *  deviceName,
size_t *  pSize 
)

Get the device name that owns the nodemap.

Parameters
[in]hNodeMapHandle to NodeMap instance.
[out]deviceNameThe name of the device.
[in,out]pSizeMaximum element of the array in input, number of element filled in output.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODEMAP_Poll()

ITALA_API_C ItalaError NODEMAP_Poll ( H_NODEMAP  hNodeMap,
int64_t  elapsedTime 
)

Fires nodes which have a polling time in the nodemap.

Parameters
[in]hNodeMapHandle to NodeMap instance.
[out]elapsedTimeElapsed time.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.