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

Functions
SPINNAKERC_API	spinFloatSetValue (spinNodeHandle hNode, double value)
	Sets the value of a float node. More...

SPINNAKERC_API	spinFloatSetValueEx (spinNodeHandle hNode, bool8_t bVerify, double value)
	Sets the value of a float node; manually set whether to verify the node. More...

SPINNAKERC_API	spinFloatGetValue (spinNodeHandle hNode, double *pValue)
	Retrieves the value of a float node. More...

SPINNAKERC_API	spinFloatGetValueEx (spinNodeHandle hNode, bool8_t bVerify, double *pValue)
	Retrieves the value of a float node; manually set whether to verify the node. More...

SPINNAKERC_API	spinFloatGetMin (spinNodeHandle hNode, double *pValue)
	Retrieves the minimum value of a float node; all potential values must be greater than or equal to the minimum. More...

SPINNAKERC_API	spinFloatGetMax (spinNodeHandle hNode, double *pValue)
	Retrieves the maximum value of a float node; all potential values must be lesser than or equal to the maximum. More...

SPINNAKERC_API	spinFloatGetRepresentation (spinNodeHandle hNode, spinRepresentation *pValue)
	Retrieves the numerical representation of the value of a node; i.e. More...

SPINNAKERC_API	spinFloatGetUnit (spinNodeHandle hNode, char pBuf, size_t pBufLen)
	Retrieves the units of the float node value. More...

Detailed Description

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

Function Documentation

◆ spinFloatGetMax()

SPINNAKERC_API spinFloatGetMax	(	spinNodeHandle	hNode,
		double *	pValue
	)

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

See also: spinError

Parameters

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

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

Examples: Exposure_C.c, Exposure_C_Quickspin.c, NodeMapCallback_C.c, and Sequencer_C.c.

◆ spinFloatGetMin()

SPINNAKERC_API spinFloatGetMin	(	spinNodeHandle	hNode,
		double *	pValue
	)

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

See also: spinError

Parameters

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

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

Examples: Sequencer_C.c.

◆ spinFloatGetRepresentation()

SPINNAKERC_API spinFloatGetRepresentation	(	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 float 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

◆ spinFloatGetUnit()

SPINNAKERC_API spinFloatGetUnit	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the units of the float node value.

See also: spinError

Parameters

hNode	The float node of the units to retrieve
pBuf	The c-string character buffer in which the value units are returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

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

◆ spinFloatGetValue()

SPINNAKERC_API spinFloatGetValue	(	spinNodeHandle	hNode,
		double *	pValue
	)

Retrieves the value of a float node.

See also: spinError

Parameters

hNode	The float node of the value to read
pValue	The double 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, Exposure_C.c, Exposure_C_Quickspin.c, NodeMapCallback_C.c, NodeMapInfo_C.c, and SaveToVideo_C.c.

◆ spinFloatGetValueEx()

SPINNAKERC_API spinFloatGetValueEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		double *	pValue
	)

Retrieves the value of a float node; manually set whether to verify the node.

See also: spinError

Parameters

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

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

◆ spinFloatSetValue()

SPINNAKERC_API spinFloatSetValue	(	spinNodeHandle	hNode,
		double	value
	)

Sets the value of a float node.

See also: spinError

Parameters

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

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

Examples: Exposure_C.c, Exposure_C_Quickspin.c, NodeMapCallback_C.c, and Sequencer_C.c.

◆ spinFloatSetValueEx()

SPINNAKERC_API spinFloatSetValueEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		double	value
	)

Sets the value of a float node; manually set whether to verify the node.

See also: spinError

Parameters

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

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

Functions

Detailed Description

Function Documentation

◆ spinFloatGetMax()

◆ spinFloatGetMin()

◆ spinFloatGetRepresentation()

◆ spinFloatGetUnit()

◆ spinFloatGetValue()

◆ spinFloatGetValueEx()

◆ spinFloatSetValue()

◆ spinFloatSetValueEx()