Group CIIntegerAccess¶

Modules > CIIntegerAccess

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.

Public Functions¶

Type	Name
	spinIntegerGetInc (spinNodeHandle hNode, int64_t * pValue)
	spinIntegerGetMax (spinNodeHandle hNode, int64_t * pValue)
	spinIntegerGetMin (spinNodeHandle hNode, int64_t * pValue)
	spinIntegerGetRepresentation (spinNodeHandle hNode, spinRepresentation * pValue)
	spinIntegerGetValue (spinNodeHandle hNode, int64_t * pValue)
	spinIntegerGetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t * pValue)
	spinIntegerSetValue (spinNodeHandle hNode, int64_t value)
	spinIntegerSetValueEx (spinNodeHandle hNode, bool8_t bVerify, int64_t value)

Public Functions Documentation¶

function spinIntegerGetInc¶

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

function spinIntegerGetMax¶

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

function spinIntegerGetMin¶

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

function spinIntegerGetRepresentation¶

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

function spinIntegerGetValue¶

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

function spinIntegerGetValueEx¶

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

function spinIntegerSetValue¶

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

function spinIntegerSetValueEx¶

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