IInteger Access

The functions in this section provide access to integer nodes using the int64_t data type. This includes value getters and setters, min, max, and increment functions, and node representation. More...

Functions
SPINNAKERC_API	spinIntegerSetValue (spinNodeHandle hNode, int64_t value)
	Sets the value of an integer node. More...
SPINNAKERC_API	spinIntegerSetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t value)
	Sets the value of an integer node; manually set whether to verify the node. More...
SPINNAKERC_API	spinIntegerGetValue (spinNodeHandle hNode, int64_t *pValue)
	Retrieves the value of an integer node. More...
SPINNAKERC_API	spinIntegerGetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t *pValue)
	Retrieves the value of an integer node; manually set whether to verify the node. More...
SPINNAKERC_API	spinIntegerGetMin (spinNodeHandle hNode, int64_t *pValue)
	Retrieves the minimum value of an integer node; all potential values must be greater than or equal to the minimum. More...
SPINNAKERC_API	spinIntegerGetMax (spinNodeHandle hNode, int64_t *pValue)
	Retrieves the maximum value of an integer node; all potential values must be lesser than or equal to the maximum. More...
SPINNAKERC_API	spinIntegerGetInc (spinNodeHandle hNode, int64_t *pValue)
	Retrieves the increment of an integer node; all possible values must be divisible by the increment. More...
SPINNAKERC_API	spinIntegerGetRepresentation (spinNodeHandle hNode, spinRepresentation *pValue)
	Retrieves the numerical representation of the value of a node; i.e. More...

Detailed Description

The functions in this section provide access to integer nodes using the int64_t data type. This includes value getters and setters, min, max, and increment functions, and node representation.

Function Documentation

spinIntegerGetInc()

SPINNAKERC_API spinIntegerGetInc	(	spinNodeHandle	hNode,
		int64_t *	pValue
	)

Retrieves the increment of an integer node; all possible values must be divisible by the increment.

See also

spinError

Parameters

hNode	The integer node of the increment to retrieve
pValue	The integer pointer in which the increment is returned

Returns

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

Examples

Sequencer_C.c.

spinIntegerGetMax()

SPINNAKERC_API spinIntegerGetMax	(	spinNodeHandle	hNode,
		int64_t *	pValue
	)

Retrieves the maximum value of an integer node; all potential values must be lesser than or equal to the maximum.

See also

spinError

Parameters

hNode	The integer node of the maximum value to retrieve
pValue	The integer pointer in which the maximum value is returned

Returns

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

Examples

ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, and Sequencer_C.c.

spinIntegerGetMin()

SPINNAKERC_API spinIntegerGetMin	(	spinNodeHandle	hNode,
		int64_t *	pValue
	)

Retrieves the minimum value of an integer node; all potential values must be greater than or equal to the minimum.

See also

spinError

Parameters

hNode	The integer node of the minimum value to retrieve
pValue	The integer pointer in which the minimum value is returned

Returns

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

Examples

ImageFormatControl_C.c, and ImageFormatControl_C_Quickspin.c.

spinIntegerGetRepresentation()

SPINNAKERC_API spinIntegerGetRepresentation	(	spinNodeHandle	hNode,
		spinRepresentation *	pValue
	)

Retrieves the numerical representation of the value of a node; i.e.

linear, logarithmic, hexidecimal, MAC address, etc.

See also

spinError

Parameters

hNode	The integer node of the numerical representation to retrieve
pValue	The representation enum pointer in which the type of numerical representation is returned

Returns

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

spinIntegerGetValue()

SPINNAKERC_API spinIntegerGetValue	(	spinNodeHandle	hNode,
		int64_t *	pValue
	)

Retrieves the value of an integer node.

See also

spinError

Parameters

hNode	The integer node of the value to read
pValue	The integer pointer in which the value is returned

Returns

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

Examples

ChunkData_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, and SaveToVideo_C.c.

spinIntegerGetValueEx()

SPINNAKERC_API spinIntegerGetValueEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		int64_t *	pValue
	)

Retrieves the value of an integer node; manually set whether to verify the node.

See also

spinError

Parameters

hNode	The integer node of the value to read
bVerify	The boolean of whether to verify the node
pValue	The integer pointer in which the value is returned

Returns

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

spinIntegerSetValue()

SPINNAKERC_API spinIntegerSetValue	(	spinNodeHandle	hNode,
		int64_t	value
	)

Sets the value of an integer node.

See also

spinError

Parameters

hNode	The integer node having its value changed
value	The integer value to set

Returns

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

Examples

ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, and Sequencer_C.c.

spinIntegerSetValueEx()

SPINNAKERC_API spinIntegerSetValueEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		int64_t	value
	)

Sets the value of an integer node; manually set whether to verify the node.

See also

spinError

Parameters

hNode	The integer node having its value changed
bVerify	The boolean of whether to verify the node
value	The integer value to set

Returns

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