NetworkTables generic publisher. More...

#include <networktables/GenericEntry.h>

Inheritance diagram for nt::GenericPublisher:

Public Types
using	TopicType = Topic

using	ValueType = Value

using	ParamType = const Value&

using	TimestampedValueType = Value

Public Member Functions
	GenericPublisher ()=default

	GenericPublisher (NT_Publisher handle)
	Construct from a publisher handle; recommended to use Topic::GenericPublish() instead.

void	Set (ParamType value)
	Publish a new 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	SetDefault (ParamType value)
	Publish a default value.

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.

TopicType	GetTopic () const
	Get the corresponding topic.

Public Member Functions inherited from nt::Publisher
virtual	~Publisher ()

	Publisher (const Publisher &)=delete

Publisher &	operator= (const Publisher &)=delete

	Publisher (Publisher &&rhs)

Publisher &	operator= (Publisher &&rhs)

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

NT_Publisher	GetHandle () const
	Gets the native handle for the publisher.

Topic	GetTopic () const
	Gets the published-to topic.

Additional Inherited Members
Protected Member Functions inherited from nt::Publisher
	Publisher ()=default

	Publisher (NT_Publisher handle)

Protected Attributes inherited from nt::Publisher
NT_Publisher	m_pubHandle {0}
	NetworkTables handle.

Detailed Description

NetworkTables generic publisher.

Member Typedef Documentation

◆ ParamType

using nt::GenericPublisher::ParamType = const Value&

◆ TimestampedValueType

using nt::GenericPublisher::TimestampedValueType = Value

◆ TopicType

using nt::GenericPublisher::TopicType = Topic

◆ ValueType

using nt::GenericPublisher::ValueType = Value

Constructor & Destructor Documentation

◆ GenericPublisher() [1/2]

nt::GenericPublisher::GenericPublisher ( )

default

◆ GenericPublisher() [2/2]

nt::GenericPublisher::GenericPublisher ( NT_Publisher handle )

inlineexplicit

Construct from a publisher handle; recommended to use Topic::GenericPublish() instead.

Parameters

handle Native handle

Member Function Documentation

◆ GetTopic()

TopicType nt::GenericPublisher::GetTopic ( ) const

inline

Get the corresponding topic.

Returns: Topic

◆ Set()

void nt::GenericPublisher::Set ( ParamType value )

inline

Publish a new value.

Parameters

value value to publish

◆ SetBoolean()

bool nt::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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

◆ SetDefault()

void nt::GenericPublisher::SetDefault ( ParamType value )

inline

Publish a default value.

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

Parameters

value value

◆ SetDefaultBoolean()

bool nt::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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

◆ SetDouble()

bool nt::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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

◆ SetRaw()

bool nt::GenericPublisher::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::GenericPublisher::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::GenericPublisher::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

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

networktables/GenericEntry.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParamType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ GenericPublisher() [1/2]

◆ GenericPublisher() [2/2]

Member Function Documentation

◆ GetTopic()

◆ Set()

◆ SetBoolean()

◆ SetBooleanArray() [1/2]

◆ SetBooleanArray() [2/2]

◆ SetDefault()

◆ SetDefaultBoolean()

◆ SetDefaultBooleanArray()

◆ SetDefaultDouble()

◆ SetDefaultDoubleArray()

◆ SetDefaultFloat()

◆ SetDefaultFloatArray()

◆ SetDefaultInteger()

◆ SetDefaultIntegerArray()

◆ SetDefaultRaw()

◆ SetDefaultString()

◆ SetDefaultStringArray()

◆ SetDouble()

◆ SetDoubleArray()

◆ SetFloat()

◆ SetFloatArray()

◆ SetInteger()

◆ SetIntegerArray()

◆ SetRaw()

◆ SetString()

◆ SetStringArray()