Group CNodeAccess¶

Modules > CNodeAccess

The functions in this section provide access to information and objects retrieved from nodes. This includes node properties and callback registration.

Public Functions¶

Type	Name
	spinNodeDeregisterCallback (spinNodeHandle hNode, spinNodeCallbackHandle hCb)
	spinNodeGetAccessMode (spinNodeHandle hNode, spinAccessMode * pAccessMode)
	spinNodeGetCachingMode (spinNodeHandle hNode, spinCachingMode * pCachingMode)
	spinNodeGetDescription (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)
	spinNodeGetDisplayName (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)
	spinNodeGetImposedAccessMode (spinNodeHandle hNode, spinAccessMode imposedAccessMode)
	spinNodeGetImposedVisibility (spinNodeHandle hNode, spinVisibility imposedVisibility)
	spinNodeGetName (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)
	spinNodeGetNameSpace (spinNodeHandle hNode, spinNameSpace * pNamespace)
	spinNodeGetPollingTime (spinNodeHandle hNode, int64_t * pPollingTime)
	spinNodeGetToolTip (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)
	spinNodeGetType (spinNodeHandle hNode, spinNodeType * pType)
	spinNodeGetVisibility (spinNodeHandle hNode, spinVisibility * pVisibility)
	spinNodeInvalidateNode (spinNodeHandle hNode)
	spinNodeIsAvailable (spinNodeHandle hNode, bool8_t * pbResult)
	spinNodeIsEqual (spinNodeHandle hNodeFirst, spinNodeHandle hNodeSecond, bool8_t * pbResult)
	spinNodeIsImplemented (spinNodeHandle hNode, bool8_t * pbResult)
	spinNodeIsReadable (spinNodeHandle hNode, bool8_t * pbResult)
	spinNodeIsWritable (spinNodeHandle hNode, bool8_t * pbResult)
	spinNodeRegisterCallback (spinNodeHandle hNode, spinNodeCallbackFunction pCbFunction, spinNodeCallbackHandle * phCb)

Public Functions Documentation¶

function spinNodeDeregisterCallback¶

spinNodeDeregisterCallback (
    spinNodeHandle hNode,
    spinNodeCallbackHandle hCb
)

Unregisters a callback from a node

See also: spinError

Parameters:

hNode The node from which to unregister the callback
hCb The callback handle to unregister

Returns:

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

function spinNodeGetAccessMode¶

spinNodeGetAccessMode (
    spinNodeHandle hNode,
    spinAccessMode * pAccessMode
)

Retrieves the access mode of a node (as an enum, spinAccessMode)

See also: spinError

See also: spinAccessMode

Parameters:

hNode The node of the access mode to retrieve
pAccessMode The access mode enum pointer in which the access mode is returned

Returns:

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

function spinNodeGetCachingMode¶

spinNodeGetCachingMode (
    spinNodeHandle hNode,
    spinCachingMode * pCachingMode
)

Retrieves the caching mode of a node (as an enum, spinCachingMode)

See also: spinError

See also: spinCachingMode

Parameters:

hNode The node of the caching mode to retrieve
pCachingMode The caching mode enum pointer in which the caching mode is returned

Returns:

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

function spinNodeGetDescription¶

spinNodeGetDescription (
    spinNodeHandle hNode,
    char * pBuf,
    size_t * pBufLen
)

Retrieves a longer description of a node

See also: spinError

Parameters:

hNode The node of the description to retrieve
pBuf The c-string character buffer in which the longer descrition of the node is 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

function spinNodeGetDisplayName¶

spinNodeGetDisplayName (
    spinNodeHandle hNode,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the display name of a node (whitespace possible)

See also: spinError

Parameters:

hNode The node of the display name to retrieve
pBuf The c-string character buffer in which the display name of the node is 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

function spinNodeGetImposedAccessMode¶

spinNodeGetImposedAccessMode (
    spinNodeHandle hNode,
    spinAccessMode imposedAccessMode
)

Retrieves the imposed access mode of a node

See also: spinError

Parameters:

hNode The node of the imposed access mode to retrieve
imposedAccessMode The access mode enum pointer in which the imposed access mode is returned

Returns:

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

function spinNodeGetImposedVisibility¶

spinNodeGetImposedVisibility (
    spinNodeHandle hNode,
    spinVisibility imposedVisibility
)

Retrieves the imposed visibility of a node

See also: spinError

Parameters:

hNode The node of the visibility to impose
imposedVisibility The visibility enum pointer in which the imposed visibility is returned

Returns:

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

function spinNodeGetName¶

spinNodeGetName (
    spinNodeHandle hNode,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the name of a node (no whitespace)

See also: spinError

Parameters:

hNode The node of the name to retrieve
pBuf The c-string character buffer in which the name of the node is 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

function spinNodeGetNameSpace¶

spinNodeGetNameSpace (
    spinNodeHandle hNode,
    spinNameSpace * pNamespace
)

Retrieve the namespace of a node (as an enum, spinNameSpace)

See also: spinError

See also: spinNameSpace

Parameters:

hNode The node of the namespace to retrieve
pNamespace The namespace enum pointer in which the namespace is returned

Returns:

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

function spinNodeGetPollingTime¶

spinNodeGetPollingTime (
    spinNodeHandle hNode,
    int64_t * pPollingTime
)

Retrieve the polling time of a node

See also: spinError

Parameters:

hNode The node of the polling time to retrieve
pPollingTime The integer pointer in which the polling time is returned

Returns:

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

function spinNodeGetToolTip¶

spinNodeGetToolTip (
    spinNodeHandle hNode,
    char * pBuf,
    size_t * pBufLen
)

Retrieves a short description of a node

See also: spinError

Parameters:

hNode The node of the tooltip to retrieve
pBuf The c-string character buffer in which the short description of the node is 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

function spinNodeGetType¶

spinNodeGetType (
    spinNodeHandle hNode,
    spinNodeType * pType
)

Retrieves the type of a node (as an enum, spinNodeType)

See also: spinError

See also: spinNodeType

Parameters:

hNode The node of the node type to retrieve
pType The node type enum pointer in which the type of node is returned

Returns:

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

function spinNodeGetVisibility¶

spinNodeGetVisibility (
    spinNodeHandle hNode,
    spinVisibility * pVisibility
)

Retrieves the recommended visibility of a node (as an enum, spinVisibility)

See also: spinError

See also: spinVisibility

Parameters:

hNode The node of the visibility to retrieve
pVisibility The visibility enum pointer in which the visibility is returned

Returns:

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

function spinNodeInvalidateNode¶

spinNodeInvalidateNode (
    spinNodeHandle hNode
)

Invalidates a node in case its values may have changed, rendering it no longer valid

See also: spinError

Parameters:

hNode The node whose values may have changed

Returns:

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

function spinNodeIsAvailable¶

spinNodeIsAvailable (
    spinNodeHandle hNode,
    bool8_t * pbResult
)

Checks whether a node is available

See also: spinError

Parameters:

hNode The node to check
pbResult The boolean pointer to return whether or not the node is available

Returns:

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

function spinNodeIsEqual¶

spinNodeIsEqual (
    spinNodeHandle hNodeFirst,
    spinNodeHandle hNodeSecond,
    bool8_t * pbResult
)

Checks whether two nodes are equal

See also: spinError

Parameters:

hNodeFirst The first node to check
hNodeSecond The second node to check
pbResult The boolean pointer to return whether or not the two nodes are equal

Returns:

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

function spinNodeIsImplemented¶

spinNodeIsImplemented (
    spinNodeHandle hNode,
    bool8_t * pbResult
)

Checks whether a node is implemented

See also: spinError

Parameters:

hNode The node to check
pbResult The boolean pointer to return whether or not the node is implemented

Returns:

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

function spinNodeIsReadable¶

spinNodeIsReadable (
    spinNodeHandle hNode,
    bool8_t * pbResult
)

Checks whether a node is readable

See also: spinError

Parameters:

hNode The node to check
pbResult The boolean pointer to return whether or not the node is readable

Returns:

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

function spinNodeIsWritable¶

spinNodeIsWritable (
    spinNodeHandle hNode,
    bool8_t * pbResult
)

Checks whether a node is writable

See also: spinError

Parameters:

hNode The node to check
pbResult The boolean pointer to return whether or not the node is writable

Returns:

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

function spinNodeRegisterCallback¶

spinNodeRegisterCallback (
    spinNodeHandle hNode,
    spinNodeCallbackFunction pCbFunction,
    spinNodeCallbackHandle * phCb
)

Registers a callback to a node

See also: spinError

Parameters:

hNode The node on which to register the callback
pCbFunction The function pointer of the function that will execute when the callback is triggered; must match signature "void spinNodeCallbackFunction(spinNodeHandle hNode)"
phCb The callback handle pointer in which the callback is returned; used to unregister callbacks

Returns:

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