Node Map Access

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

Functions
SPINNAKERC_API	spinNodeMapGetNode (spinNodeMapHandle hNodeMap, const char *pName, spinNodeHandle *phNode)
	Retrieves a node from the nodemap by name. More...
SPINNAKERC_API	spinNodeMapGetNumNodes (spinNodeMapHandle hNodeMap, size_t *pValue)
	Gets the number of nodes in the map. More...
SPINNAKERC_API	spinNodeMapGetNodeByIndex (spinNodeMapHandle hNodeMap, size_t index, spinNodeHandle *phNode)
	Retrieves a node from the nodemap by index. More...
SPINNAKERC_API	spinNodeMapReleaseNode (spinNodeMapHandle hNodeMap, spinNodeHandle hNode)
	Releases the entry node handle. More...
SPINNAKERC_API	spinNodeMapPoll (spinNodeMapHandle hNodeMap, int64_t timestamp)
	Fires nodes which have a polling time. More...

Detailed Description

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

Function Documentation

spinNodeMapGetNode()

SPINNAKERC_API 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

Examples

Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Enumeration_C.c, EnumerationEvents_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

spinNodeMapGetNodeByIndex()

SPINNAKERC_API 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

spinNodeMapGetNumNodes()

SPINNAKERC_API 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

spinNodeMapPoll()

SPINNAKERC_API 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

spinNodeMapReleaseNode()

SPINNAKERC_API 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

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