Double Functions

Functions
NT_Bool	NT_SetDouble (NT_Handle pubentry, int64_t time, double value)
	Publish a new value.
NT_Bool	NT_SetDefaultDouble (NT_Handle pubentry, double defaultValue)
	Publish a default value.
double	NT_GetDouble (NT_Handle subentry, double defaultValue)
	Get the last published value.
void	NT_GetAtomicDouble (NT_Handle subentry, double defaultValue, struct NT_TimestampedDouble *value)
	Get the last published value along with its timestamp.
void	NT_DisposeTimestampedDouble (struct NT_TimestampedDouble *value)
	Disposes a timestamped value (as returned by NT_GetAtomicDouble).
struct NT_TimestampedDouble *	NT_ReadQueueDouble (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue.
void	NT_FreeQueueDouble (struct NT_TimestampedDouble *arr, size_t len)
	Frees a timestamped array of values (as returned by NT_ReadQueueDouble).
double *	NT_ReadQueueValuesDouble (NT_Handle subentry, size_t *len)
	Get an array of all value changes since the last call to ReadQueue.

Detailed Description

Function Documentation

NT_DisposeTimestampedDouble()

void NT_DisposeTimestampedDouble

(

struct NT_TimestampedDouble *

value

)

Disposes a timestamped value (as returned by NT_GetAtomicDouble).

Parameters

value

timestamped value

NT_FreeQueueDouble()

void NT_FreeQueueDouble	(	struct NT_TimestampedDouble *	arr,
		size_t	len )

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

Parameters

arr	array
len	length of array

NT_GetAtomicDouble()

void NT_GetAtomicDouble	(	NT_Handle	subentry,
		double	defaultValue,
		struct NT_TimestampedDouble *	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_GetDouble()

double NT_GetDouble	(	NT_Handle	subentry,
		double	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_ReadQueueDouble()

struct NT_TimestampedDouble * NT_ReadQueueDouble	(	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_ReadQueueValuesDouble()

double * NT_ReadQueueValuesDouble	(	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_SetDefaultDouble()

NT_Bool NT_SetDefaultDouble	(	NT_Handle	pubentry,
		double	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_SetDouble()

NT_Bool NT_SetDouble	(	NT_Handle	pubentry,
		int64_t	time,
		double	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