NetworkTables Entry. More...

#include <networktables/NetworkTableEntry.h>

Public Member Functions
	NetworkTableEntry ()=default
	Construct invalid instance.

	NetworkTableEntry (NT_Entry handle)
	Construct from native handle.

	operator bool () const
	Determines if the native handle is valid.

NT_Entry	GetHandle () const
	Gets the native handle for the entry.

NetworkTableInstance	GetInstance () const
	Gets the instance for the entry.

bool	Exists () const
	Determines if the entry currently exists.

std::string	GetName () const
	Gets the name of the entry (the key).

NetworkTableType	GetType () const
	Gets the type of the entry.

int64_t	GetLastChange () const
	Gets the last time the entry's value was changed.

Value	GetValue () const
	Gets the entry's value.

bool	GetBoolean (bool defaultValue) const
	Gets the entry's value as a boolean.

int64_t	GetInteger (int64_t defaultValue) const
	Gets the entry's value as a integer.

float	GetFloat (float defaultValue) const
	Gets the entry's value as a float.

double	GetDouble (double defaultValue) const
	Gets the entry's value as a double.

std::string	GetString (std::string_view defaultValue) const
	Gets the entry's value as a string.

std::vector< uint8_t >	GetRaw (std::span< const uint8_t > defaultValue) const
	Gets the entry's value as a raw.

std::vector< int >	GetBooleanArray (std::span< const int > defaultValue) const
	Gets the entry's value as a boolean array.

std::vector< int64_t >	GetIntegerArray (std::span< const int64_t > defaultValue) const
	Gets the entry's value as a integer array.

std::vector< float >	GetFloatArray (std::span< const float > defaultValue) const
	Gets the entry's value as a float array.

std::vector< double >	GetDoubleArray (std::span< const double > defaultValue) const
	Gets the entry's value as a double array.

std::vector< std::string >	GetStringArray (std::span< const std::string > defaultValue) const
	Gets the entry's value as a string array.

std::vector< NetworkTableValue >	ReadQueue ()
	Get an array of all value changes since the last call to ReadQueue.

bool	SetDefaultValue (const Value &defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultBoolean (bool defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultInteger (int64_t defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultFloat (float defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultDouble (double defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultString (std::string_view defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultRaw (std::span< const uint8_t > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultBooleanArray (std::span< const int > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultIntegerArray (std::span< const int64_t > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultFloatArray (std::span< const float > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultDoubleArray (std::span< const double > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetDefaultStringArray (std::span< const std::string > defaultValue)
	Sets the entry's value if it does not exist.

bool	SetValue (const Value &value)
	Sets the entry's value.

bool	SetBoolean (bool value, int64_t time=0)
	Sets the entry's value.

bool	SetInteger (int64_t value, int64_t time=0)
	Sets the entry's value.

bool	SetFloat (float value, int64_t time=0)
	Sets the entry's value.

bool	SetDouble (double value, int64_t time=0)
	Sets the entry's value.

bool	SetString (std::string_view value, int64_t time=0)
	Sets the entry's value.

bool	SetRaw (std::span< const uint8_t > value, int64_t time=0)
	Sets the entry's value.

bool	SetBooleanArray (std::span< const bool > value, int64_t time=0)
	Sets the entry's value.

bool	SetBooleanArray (std::span< const int > value, int64_t time=0)
	Sets the entry's value.

bool	SetIntegerArray (std::span< const int64_t > value, int64_t time=0)
	Sets the entry's value.

bool	SetFloatArray (std::span< const float > value, int64_t time=0)
	Sets the entry's value.

bool	SetDoubleArray (std::span< const double > value, int64_t time=0)
	Sets the entry's value.

bool	SetStringArray (std::span< const std::string > value, int64_t time=0)
	Sets the entry's value.

void	SetPersistent ()
	Make value persistent through program restarts.

void	ClearPersistent ()
	Stop making value persistent through program restarts.

bool	IsPersistent () const
	Returns whether the value is persistent through program restarts.

void	Unpublish ()
	Stops publishing the entry if it's been published.

Topic	GetTopic () const
	Gets the entry's topic.

bool	operator== (const NetworkTableEntry &) const =default
	Equality operator.

Protected Attributes
NT_Entry	m_handle {0}

Detailed Description

NetworkTables Entry.

Note: For backwards compatibility, the NetworkTableEntry destructor does not release the entry.

Constructor & Destructor Documentation

◆ NetworkTableEntry() [1/2]

nt::NetworkTableEntry::NetworkTableEntry ( )

default

Construct invalid instance.

◆ NetworkTableEntry() [2/2]

nt::NetworkTableEntry::NetworkTableEntry ( NT_Entry handle )

inlineexplicit

Construct from native handle.

Parameters

handle Native handle

Member Function Documentation

◆ ClearPersistent()

void nt::NetworkTableEntry::ClearPersistent ( )

inline

Stop making value persistent through program restarts.

◆ Exists()

bool nt::NetworkTableEntry::Exists ( ) const

inline

Determines if the entry currently exists.

Returns: True if the entry exists, false otherwise.

◆ GetBoolean()

bool nt::NetworkTableEntry::GetBoolean ( bool defaultValue ) const

inline

Gets the entry's value as a boolean.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetBooleanArray()

std::vector< int > nt::NetworkTableEntry::GetBooleanArray ( std::span< const int > defaultValue ) const

inline

Gets the entry's value as a boolean array.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

Note: This makes a copy of the array. If the overhead of this is a concern, use GetValue() instead.; The returned array is std::vector<int> instead of std::vector<bool> because std::vector<bool> is special-cased in C++. 0 is false, any non-zero value is true.

◆ GetDouble()

double nt::NetworkTableEntry::GetDouble ( double defaultValue ) const

inline

Gets the entry's value as a double.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetDoubleArray()

std::vector< double > nt::NetworkTableEntry::GetDoubleArray ( std::span< const double > defaultValue ) const

inline

Gets the entry's value as a double array.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

Note: This makes a copy of the array. If the overhead of this is a concern, use GetValue() instead.

◆ GetFloat()

float nt::NetworkTableEntry::GetFloat ( float defaultValue ) const

inline

Gets the entry's value as a float.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetFloatArray()

std::vector< float > nt::NetworkTableEntry::GetFloatArray ( std::span< const float > defaultValue ) const

inline

Gets the entry's value as a float array.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

Note: This makes a copy of the array. If the overhead of this is a concern, use GetValue() instead.

◆ GetHandle()

NT_Entry nt::NetworkTableEntry::GetHandle ( ) const

inline

Gets the native handle for the entry.

Returns: Native handle

◆ GetInstance()

NetworkTableInstance nt::NetworkTableEntry::GetInstance ( ) const

Gets the instance for the entry.

Returns: Instance

◆ GetInteger()

int64_t nt::NetworkTableEntry::GetInteger ( int64_t defaultValue ) const

inline

Gets the entry's value as a integer.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetIntegerArray()

std::vector< int64_t > nt::NetworkTableEntry::GetIntegerArray ( std::span< const int64_t > defaultValue ) const

inline

Gets the entry's value as a integer array.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

Note: This makes a copy of the array. If the overhead of this is a concern, use GetValue() instead.

◆ GetLastChange()

int64_t nt::NetworkTableEntry::GetLastChange ( ) const

inline

Gets the last time the entry's value was changed.

Returns: Entry last change time

◆ GetName()

std::string nt::NetworkTableEntry::GetName ( ) const

inline

Gets the name of the entry (the key).

Returns: the entry's name

◆ GetRaw()

std::vector< uint8_t > nt::NetworkTableEntry::GetRaw ( std::span< const uint8_t > defaultValue ) const

inline

Gets the entry's value as a raw.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetString()

std::string nt::NetworkTableEntry::GetString ( std::string_view defaultValue ) const

inline

Gets the entry's value as a string.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

◆ GetStringArray()

std::vector< std::string > nt::NetworkTableEntry::GetStringArray ( std::span< const std::string > defaultValue ) const

inline

Gets the entry's value as a string array.

If the entry does not exist or is of different type, it will return the default value.

Parameters

defaultValue the value to be returned if no value is found

Returns: the entry's value or the given default value

Note: This makes a copy of the array. If the overhead of this is a concern, use GetValue() instead.

◆ GetTopic()

Topic nt::NetworkTableEntry::GetTopic ( ) const

Gets the entry's topic.

Returns: Topic

◆ GetType()

NetworkTableType nt::NetworkTableEntry::GetType ( ) const

inline

Gets the type of the entry.

Returns: the entry's type

◆ GetValue()

Value nt::NetworkTableEntry::GetValue ( ) const

inline

Gets the entry's value.

If the entry does not exist, returns an empty value.

Returns: the entry's value or an empty value if it does not exist.

◆ IsPersistent()

bool nt::NetworkTableEntry::IsPersistent ( ) const

inline

Returns whether the value is persistent through program restarts.

Returns: True if the value is persistent.

◆ operator bool()

nt::NetworkTableEntry::operator bool ( ) const

inlineexplicit

Determines if the native handle is valid.

Returns: True if the native handle is valid, false otherwise.

◆ operator==()

bool nt::NetworkTableEntry::operator== ( const NetworkTableEntry & ) const

default

Equality operator.

Returns true if both instances refer to the same native handle.

◆ ReadQueue()

std::vector< NetworkTableValue > nt::NetworkTableEntry::ReadQueue ( )

inline

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

The "poll storage" subscribe option can be used to set the queue depth.

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

◆ SetBoolean()

bool nt::NetworkTableEntry::SetBoolean	(	bool	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetBooleanArray() [1/2]

bool nt::NetworkTableEntry::SetBooleanArray	(	std::span< const bool >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetBooleanArray() [2/2]

bool nt::NetworkTableEntry::SetBooleanArray	(	std::span< const int >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetDefaultBoolean()

bool nt::NetworkTableEntry::SetDefaultBoolean ( bool defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultBooleanArray()

bool nt::NetworkTableEntry::SetDefaultBooleanArray ( std::span< const int > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultDouble()

bool nt::NetworkTableEntry::SetDefaultDouble ( double defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultDoubleArray()

bool nt::NetworkTableEntry::SetDefaultDoubleArray ( std::span< const double > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultFloat()

bool nt::NetworkTableEntry::SetDefaultFloat ( float defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultFloatArray()

bool nt::NetworkTableEntry::SetDefaultFloatArray ( std::span< const float > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultInteger()

bool nt::NetworkTableEntry::SetDefaultInteger ( int64_t defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultIntegerArray()

bool nt::NetworkTableEntry::SetDefaultIntegerArray ( std::span< const int64_t > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultRaw()

bool nt::NetworkTableEntry::SetDefaultRaw ( std::span< const uint8_t > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultString()

bool nt::NetworkTableEntry::SetDefaultString ( std::string_view defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultStringArray()

bool nt::NetworkTableEntry::SetDefaultStringArray ( std::span< const std::string > defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDefaultValue()

bool nt::NetworkTableEntry::SetDefaultValue ( const Value & defaultValue )

inline

Sets the entry's value if it does not exist.

Parameters

defaultValue the default value to set

Returns: True if the entry did not already have a value, otherwise False

◆ SetDouble()

bool nt::NetworkTableEntry::SetDouble	(	double	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetDoubleArray()

bool nt::NetworkTableEntry::SetDoubleArray	(	std::span< const double >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetFloat()

bool nt::NetworkTableEntry::SetFloat	(	float	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetFloatArray()

bool nt::NetworkTableEntry::SetFloatArray	(	std::span< const float >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetInteger()

bool nt::NetworkTableEntry::SetInteger	(	int64_t	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetIntegerArray()

bool nt::NetworkTableEntry::SetIntegerArray	(	std::span< const int64_t >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetPersistent()

void nt::NetworkTableEntry::SetPersistent ( )

inline

Make value persistent through program restarts.

◆ SetRaw()

bool nt::NetworkTableEntry::SetRaw	(	std::span< const uint8_t >	value,
		int64_t	time = 0 )

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetString()

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

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetStringArray()

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

inline

Sets the entry's value.

Parameters

value	the value to set
time	the timestamp to set (0 = nt::Now())

Returns: False if the entry exists with a different type

◆ SetValue()

bool nt::NetworkTableEntry::SetValue ( const Value & value )

inline

Sets the entry's value.

Parameters

value the value to set

Returns: False if the entry exists with a different type

◆ Unpublish()

void nt::NetworkTableEntry::Unpublish ( )

inline

Stops publishing the entry if it's been published.

Member Data Documentation

◆ m_handle

NT_Entry nt::NetworkTableEntry::m_handle {0}

protected

The documentation for this class was generated from the following file:

networktables/NetworkTableEntry.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NetworkTableEntry() [1/2]

◆ NetworkTableEntry() [2/2]

Member Function Documentation

◆ ClearPersistent()

◆ Exists()

◆ GetBoolean()

◆ GetBooleanArray()

◆ GetDouble()

◆ GetDoubleArray()

◆ GetFloat()

◆ GetFloatArray()

◆ GetHandle()

◆ GetInstance()

◆ GetInteger()

◆ GetIntegerArray()

◆ GetLastChange()

◆ GetName()

◆ GetRaw()

◆ GetString()

◆ GetStringArray()

◆ GetTopic()

◆ GetType()

◆ GetValue()

◆ IsPersistent()

◆ operator bool()

◆ operator==()

◆ ReadQueue()

◆ SetBoolean()

◆ SetBooleanArray() [1/2]

◆ SetBooleanArray() [2/2]

◆ SetDefaultBoolean()

◆ SetDefaultBooleanArray()

◆ SetDefaultDouble()

◆ SetDefaultDoubleArray()

◆ SetDefaultFloat()

◆ SetDefaultFloatArray()

◆ SetDefaultInteger()

◆ SetDefaultIntegerArray()

◆ SetDefaultRaw()

◆ SetDefaultString()

◆ SetDefaultStringArray()

◆ SetDefaultValue()

◆ SetDouble()

◆ SetDoubleArray()

◆ SetFloat()

◆ SetFloatArray()

◆ SetInteger()

◆ SetIntegerArray()

◆ SetPersistent()

◆ SetRaw()

◆ SetString()

◆ SetStringArray()

◆ SetValue()

◆ Unpublish()

Member Data Documentation

◆ m_handle