Group CNodeMapAccess¶

Modules > CNodeMapAccess

The functions in this section provide access to information, objects, and functionality related to nodemaps. This includes nodes, node counts, and polling.

Public Functions¶

Type	Name
	spinNodeMapGetNode (spinNodeMapHandle hNodeMap, const char * pName, spinNodeHandle * phNode)
	spinNodeMapGetNodeByIndex (spinNodeMapHandle hNodeMap, size_t index, spinNodeHandle * phNode)
	spinNodeMapGetNumNodes (spinNodeMapHandle hNodeMap, size_t * pValue)
	spinNodeMapPoll (spinNodeMapHandle hNodeMap, int64_t timestamp)
	spinNodeMapReleaseNode (spinNodeMapHandle hNodeMap, spinNodeHandle hNode)

Public Functions Documentation¶

function spinNodeMapGetNode¶

spinNodeMapGetNode (
    spinNodeMapHandle hNodeMap,
    const char * pName,
    spinNodeHandle * phNode
)

Retrieves a node from the nodemap by name

See also: spinError

Parameters:

hNodeMap The node map where the node is
pName The name of the node
phNode The node handle pointer in which the node is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeMapGetNodeByIndex¶

spinNodeMapGetNodeByIndex (
    spinNodeMapHandle hNodeMap,
    size_t index,
    spinNodeHandle * phNode
)

Retrieves a node from the nodemap by index

See also: spinError

Parameters:

hNodeMap The node map where the node is
index The index of the node
phNode The node handle pointer in which the node is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeMapGetNumNodes¶

spinNodeMapGetNumNodes (
    spinNodeMapHandle hNodeMap,
    size_t * pValue
)

Gets the number of nodes in the map

See also: spinError

Parameters:

hNodeMap The node map where the nodes to be counted are
pValue The unsigned integer pointer in which the number of nodes is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeMapPoll¶

spinNodeMapPoll (
    spinNodeMapHandle hNodeMap,
    int64_t timestamp
)

Fires nodes which have a polling time

See also: spinError

Parameters:

hNodeMap The nodemap to poll
timestamp The timestamp

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeMapReleaseNode¶

spinNodeMapReleaseNode (
    spinNodeMapHandle hNodeMap,
    spinNodeHandle hNode
)

Releases the entry node handle. Make sure node handle is cleaned up properly by setting it to NULL after the node is released. If this function is not explicitly called, the handle will be released upon the release of the camera handle.

See also: spinCameraRelease

See also: spinError

Parameters:

hNodeMap The node map from which the node handle is retrieved
hNode The node handle to be released

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error