WPILibC++ 2024.3.2
String Functions

Functions

bool nt::SetString (NT_Handle pubentry, std::string_view value, int64_t time=0)
 Publish a new value. More...
 
bool nt::SetDefaultString (NT_Handle pubentry, std::string_view defaultValue)
 Publish a default value. More...
 
std::string nt::GetString (NT_Handle subentry, std::string_view defaultValue)
 Get the last published value. More...
 
TimestampedString nt::GetAtomicString (NT_Handle subentry, std::string_view defaultValue)
 Get the last published value along with its timestamp. More...
 
std::vector< TimestampedStringnt::ReadQueueString (NT_Handle subentry)
 Get an array of all value changes since the last call to ReadQueue. More...
 
std::vector< std::string > nt::ReadQueueValuesString (NT_Handle subentry)
 Get an array of all value changes since the last call to ReadQueue. More...
 
std::string_view nt::GetString (NT_Handle subentry, wpi::SmallVectorImpl< char > &buf, std::string_view defaultValue)
 
TimestampedStringView nt::GetAtomicString (NT_Handle subentry, wpi::SmallVectorImpl< char > &buf, std::string_view defaultValue)
 

Detailed Description

Function Documentation

◆ GetAtomicString() [1/2]

TimestampedString nt::GetAtomicString ( NT_Handle  subentry,
std::string_view  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
subentrysubscriber or entry handle
defaultValuedefault value to return if no value has been published
Returns
timestamped value

◆ GetAtomicString() [2/2]

TimestampedStringView nt::GetAtomicString ( NT_Handle  subentry,
wpi::SmallVectorImpl< char > &  buf,
std::string_view  defaultValue 
)

◆ GetString() [1/2]

std::string nt::GetString ( NT_Handle  subentry,
std::string_view  defaultValue 
)

Get the last published value.

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

Parameters
subentrysubscriber or entry handle
defaultValuedefault value to return if no value has been published
Returns
value

◆ GetString() [2/2]

std::string_view nt::GetString ( NT_Handle  subentry,
wpi::SmallVectorImpl< char > &  buf,
std::string_view  defaultValue 
)

◆ ReadQueueString()

std::vector< TimestampedString > nt::ReadQueueString ( 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
subentrysubscriber or entry handle
Returns
Array of timestamped values; empty array if no new changes have been published since the previous call.

◆ ReadQueueValuesString()

std::vector< std::string > nt::ReadQueueValuesString ( 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
subentrysubscriber or entry handle
Returns
Array of values; empty array if no new changes have been published since the previous call.

◆ SetDefaultString()

bool nt::SetDefaultString ( NT_Handle  pubentry,
std::string_view  defaultValue 
)

Publish a default value.

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

Parameters
pubentrypublisher or entry handle
defaultValuedefault value

◆ SetString()

bool nt::SetString ( NT_Handle  pubentry,
std::string_view  value,
int64_t  time = 0 
)

Publish a new value.

Parameters
pubentrypublisher or entry handle
valuevalue to publish
timetimestamp; 0 indicates current NT time should be used