WPILibC++ 2024.3.2
Boolean Functions

Functions

bool nt::SetBoolean (NT_Handle pubentry, bool value, int64_t time=0)
 Publish a new value. More...
 
bool nt::SetDefaultBoolean (NT_Handle pubentry, bool defaultValue)
 Publish a default value. More...
 
bool nt::GetBoolean (NT_Handle subentry, bool defaultValue)
 Get the last published value. More...
 
TimestampedBoolean nt::GetAtomicBoolean (NT_Handle subentry, bool defaultValue)
 Get the last published value along with its timestamp. More...
 
std::vector< TimestampedBooleannt::ReadQueueBoolean (NT_Handle subentry)
 Get an array of all value changes since the last call to ReadQueue. More...
 
std::vector< int > nt::ReadQueueValuesBoolean (NT_Handle subentry)
 Get an array of all value changes since the last call to ReadQueue. More...
 

Detailed Description

Function Documentation

◆ GetAtomicBoolean()

TimestampedBoolean nt::GetAtomicBoolean ( NT_Handle  subentry,
bool  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

◆ GetBoolean()

bool nt::GetBoolean ( NT_Handle  subentry,
bool  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

◆ ReadQueueBoolean()

std::vector< TimestampedBoolean > nt::ReadQueueBoolean ( 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.

◆ ReadQueueValuesBoolean()

std::vector< int > nt::ReadQueueValuesBoolean ( 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.

◆ SetBoolean()

bool nt::SetBoolean ( NT_Handle  pubentry,
bool  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

◆ SetDefaultBoolean()

bool nt::SetDefaultBoolean ( NT_Handle  pubentry,
bool  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