FloatArray Functions

Functions
NT_Bool	NT_SetFloatArray (NT_Handle pubentry, int64_t time, const float *value, size_t len)
	Publish a new value.
NT_Bool	NT_SetDefaultFloatArray (NT_Handle pubentry, const float *defaultValue, size_t defaultValueLen)
	Publish a default value.
float *	NT_GetFloatArray (NT_Handle subentry, const float *defaultValue, size_t defaultValueLen, size_t *len)
	Get the last published value.
void	NT_GetAtomicFloatArray (NT_Handle subentry, const float *defaultValue, size_t defaultValueLen, struct NT_TimestampedFloatArray *value)
	Get the last published value along with its timestamp.
void	NT_DisposeTimestampedFloatArray (struct NT_TimestampedFloatArray *value)
	Disposes a timestamped value (as returned by NT_GetAtomicFloatArray).
struct NT_TimestampedFloatArray *	NT_ReadQueueFloatArray (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue.
void	NT_FreeQueueFloatArray (struct NT_TimestampedFloatArray *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueFloatArray).

Detailed Description

Function Documentation

NT_DisposeTimestampedFloatArray()

void NT_DisposeTimestampedFloatArray

(

struct NT_TimestampedFloatArray *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicFloatArray).

Parameters

value

timestamped value

NT_FreeQueueFloatArray()

void NT_FreeQueueFloatArray	(	struct NT_TimestampedFloatArray *	arr,
		size_t	len )

Frees a timestamped array of values (as returned by NT_ReadQueueFloatArray).

Parameters

arr	array
len	length of array

NT_GetAtomicFloatArray()

void NT_GetAtomicFloatArray	(	NT_Handle	subentry,
		const float *	defaultValue,
		size_t	defaultValueLen,
		struct NT_TimestampedFloatArray *	value )

Get the last published value along with its timestamp.

If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters

subentry	subscriber or entry handle
defaultValue	default value to return if no value has been published
defaultValueLen	length of default value
value	timestamped value (output)

NT_GetFloatArray()

float * NT_GetFloatArray	(	NT_Handle	subentry,
		const float *	defaultValue,
		size_t	defaultValueLen,
		size_t *	len )

Get the last published value.

If no value has been published, returns the passed defaultValue.

Parameters

subentry	subscriber or entry handle
defaultValue	default value to return if no value has been published
defaultValueLen	length of default value
len	length of returned value (output)

Returns

value

NT_ReadQueueFloatArray()

struct NT_TimestampedFloatArray * NT_ReadQueueFloatArray	(	NT_Handle	subentry,
		size_t *	len )

Get an array of all value changes since the last call to ReadQueue.

Also provides a timestamp for each value.

Note

The "poll storage" subscribe option can be used to set the queue depth.

Parameters

subentry	subscriber or entry handle
len	length of returned array (output)

Returns

Array of timestamped values; NULL if no new changes have been published since the previous call.

NT_SetDefaultFloatArray()

NT_Bool NT_SetDefaultFloatArray	(	NT_Handle	pubentry,
		const float *	defaultValue,
		size_t	defaultValueLen )

Publish a default value.

On reconnect, a default value will never be used in preference to a published value.

Parameters

pubentry	publisher or entry handle
defaultValue	default value
defaultValueLen	length of default value

NT_SetFloatArray()

NT_Bool NT_SetFloatArray	(	NT_Handle	pubentry,
		int64_t	time,
		const float *	value,
		size_t	len )

Publish a new value.

Parameters

pubentry	publisher or entry handle
time	timestamp; 0 indicates current NT time should be used
value	value to publish
len	length of value