Group CIRegister¶

Modules > CIRegister

The functions in this section provide access to register nodes. This includes access to the node, its address and length, and reference.

Public Functions¶

Type	Name
	spinRegisterGet (spinNodeHandle hNode, uint8_t * pBuf, int64_t length)
	spinRegisterGetAddress (spinNodeHandle hNode, int64_t * pAddress)
	spinRegisterGetEx (spinNodeHandle hNode, bool8_t bVerify, bool8_t bIgnoreCache, uint8_t * pBuf, int64_t length)
	spinRegisterGetLength (spinNodeHandle hNode, int64_t * pLength)
	spinRegisterSet (spinNodeHandle hNode, const uint8_t * pBuf, int64_t length)
	spinRegisterSetEx (spinNodeHandle hNode, bool8_t bVerify, const uint8_t * pBuf, int64_t length)
	spinRegisterSetReference (spinNodeHandle hNode, spinNodeHandle hRef)

Public Functions Documentation¶

function spinRegisterGet¶

spinRegisterGet (
    spinNodeHandle hNode,
    uint8_t * pBuf,
    int64_t length
)

Retrieves the value of a register node

See also: spinError

Parameters:

hNode The register node of the value to retrieve
pBuf The unsigned integer buffer in which the value is returned
length The integer pointer in which the length of the register array is returned; the input value is the maximum length

Returns:

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

function spinRegisterGetAddress¶

spinRegisterGetAddress (
    spinNodeHandle hNode,
    int64_t * pAddress
)

Retrieves the address of a register node

See also: spinError

Parameters:

hNode The register node of the address to retrieve
pAddress The integer pointer in which the address is returned

Returns:

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

function spinRegisterGetEx¶

spinRegisterGetEx (
    spinNodeHandle hNode,
    bool8_t bVerify,
    bool8_t bIgnoreCache,
    uint8_t * pBuf,
    int64_t length
)

Retrieves the value of a register node; manually set whether to verify the node and whether to ignore the cache

See also: spinError

Parameters:

hNode The register node of the value to retrieve
bVerify The boolean of whether to verify the node
IgnoreCache The boolean of whether to ignore the cache
pBuf The unsigned integer buffer in which the value is returned
length The integer pointer in which the length of the register array is returned; the input value is the maximum length

Returns:

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

function spinRegisterGetLength¶

spinRegisterGetLength (
    spinNodeHandle hNode,
    int64_t * pLength
)

Retrieves the length (in bytes) of the value of a register node

See also: spinError

Parameters:

hNode The register node of the length to retrieve
plength The integer in which the number of bytes is returned

Returns:

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

function spinRegisterSet¶

spinRegisterSet (
    spinNodeHandle hNode,
    const uint8_t * pBuf,
    int64_t length
)

Sets the value of a register node

See also: spinError

Parameters:

hNode The register node of the value to set
pBuf The unsigned integer buffer of the value to set
length The number of bytes of the value to set

Returns:

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

function spinRegisterSetEx¶

spinRegisterSetEx (
    spinNodeHandle hNode,
    bool8_t bVerify,
    const uint8_t * pBuf,
    int64_t length
)

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

See also: spinError

Parameters:

hNode The register node of the value to set
bVerify The boolean of whether to verify the node
pBuf The unsigned integer buffer of the value to set
length The number of bytes of the value to set

Returns:

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

function spinRegisterSetReference¶

spinRegisterSetReference (
    spinNodeHandle hNode,
    spinNodeHandle hRef
)

Uses a second node as a reference for a register node

See also: spinError

Parameters:

hNode The register node that houses the reference
hRef The reference node

Returns:

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