Float Functions

Functions
NT_Bool	NT_SetFloat (NT_Handle pubentry, int64_t time, float value)
	Publish a new value. More...
NT_Bool	NT_SetDefaultFloat (NT_Handle pubentry, float defaultValue)
	Publish a default value. More...
float	NT_GetFloat (NT_Handle subentry, float defaultValue)
	Get the last published value. More...
void	NT_GetAtomicFloat (NT_Handle subentry, float defaultValue, struct NT_TimestampedFloat *value)
	Get the last published value along with its timestamp. More...
void	NT_DisposeTimestampedFloat (struct NT_TimestampedFloat *value)
	Disposes a timestamped value (as returned by NT_GetAtomicFloat). More...
struct NT_TimestampedFloat *	NT_ReadQueueFloat (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue. More...
void	NT_FreeQueueFloat (struct NT_TimestampedFloat *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueFloat). More...
float *	NT_ReadQueueValuesFloat (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue. More...

Detailed Description

Function Documentation

NT_DisposeTimestampedFloat()

void NT_DisposeTimestampedFloat

(

struct NT_TimestampedFloat *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicFloat).

Parameters

value

timestamped value

NT_FreeQueueFloat()

void NT_FreeQueueFloat	(	struct NT_TimestampedFloat *	arr,
		size_t	len
	)

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

Parameters

arr	array
len	length of array

NT_GetAtomicFloat()

void NT_GetAtomicFloat	(	NT_Handle	subentry,
		float	defaultValue,
		struct NT_TimestampedFloat *	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
value	timestamped value (output)

NT_GetFloat()

float NT_GetFloat	(	NT_Handle	subentry,
		float	defaultValue
	)

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

Returns

value

NT_ReadQueueFloat()

struct NT_TimestampedFloat * NT_ReadQueueFloat	(	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_ReadQueueValuesFloat()

float * NT_ReadQueueValuesFloat	(	NT_Handle	subentry,
		size_t *	len
	)

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

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 values; NULL if no new changes have been published since the previous call.

NT_SetDefaultFloat()

NT_Bool NT_SetDefaultFloat	(	NT_Handle	pubentry,
		float	defaultValue
	)

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

NT_SetFloat()

NT_Bool NT_SetFloat	(	NT_Handle	pubentry,
		int64_t	time,
		float	value
	)

Publish a new value.

Parameters

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