StringArray Functions

Functions
bool	nt::SetStringArray (NT_Handle pubentry, std::span< const std::string > value, int64_t time=0)
	Publish a new value. More...
bool	nt::SetDefaultStringArray (NT_Handle pubentry, std::span< const std::string > defaultValue)
	Publish a default value. More...
std::vector< std::string >	nt::GetStringArray (NT_Handle subentry, std::span< const std::string > defaultValue)
	Get the last published value. More...
TimestampedStringArray	nt::GetAtomicStringArray (NT_Handle subentry, std::span< const std::string > defaultValue)
	Get the last published value along with its timestamp. More...
std::vector< TimestampedStringArray >	nt::ReadQueueStringArray (NT_Handle subentry)
	Get an array of all value changes since the last call to ReadQueue. More...
std::vector< std::vector< std::string > >	nt::ReadQueueValuesStringArray (NT_Handle subentry)
	Get an array of all value changes since the last call to ReadQueue. More...

Detailed Description

Function Documentation

GetAtomicStringArray()

TimestampedStringArray nt::GetAtomicStringArray	(	NT_Handle	subentry,
		std::span< const std::string >	defaultValue
	)

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

Returns

timestamped value

GetStringArray()

std::vector< std::string > nt::GetStringArray	(	NT_Handle	subentry,
		std::span< const std::string >	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

ReadQueueStringArray()

std::vector< TimestampedStringArray > nt::ReadQueueStringArray

(

NT_Handle

subentry

)

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

Returns

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

ReadQueueValuesStringArray()

std::vector< std::vector< std::string > > nt::ReadQueueValuesStringArray

(

NT_Handle

subentry

)

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

Returns

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

SetDefaultStringArray()

bool nt::SetDefaultStringArray	(	NT_Handle	pubentry,
		std::span< const std::string >	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

SetStringArray()

bool nt::SetStringArray	(	NT_Handle	pubentry,
		std::span< const std::string >	value,
		int64_t	time = 0
	)

Publish a new value.

Parameters

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