NetworkTables generic entry. More...

#include <wpi/nt/GenericEntry.hpp>

Inheritance diagram for wpi::nt::GenericEntry:

Public Types
using	SubscriberType = GenericSubscriber
using	PublisherType = GenericPublisher
using	TopicType = Topic
using	ValueType = Value
using	ParamType = const Value&
using	TimestampedValueType = Value
Public Types inherited from wpi::nt::GenericSubscriber
using	TopicType = Topic
using	ValueType = Value
using	ParamType = const Value&
using	TimestampedValueType = Value
Public Types inherited from wpi::nt::GenericPublisher
using	TopicType = Topic
using	ValueType = Value
using	ParamType = const Value&
using	TimestampedValueType = Value

Public Member Functions
	GenericEntry ()=default
	GenericEntry (NT_Entry handle)
	Construct from an entry handle; recommended to use RawTopic::GetEntry() instead.
	operator bool () const
	Determines if the native handle is valid.
NT_Entry	GetHandle () const
	Gets the native handle for the entry.
TopicType	GetTopic () const
	Get the corresponding topic.
void	Unpublish ()
	Stops publishing the entry if it's published.
Public Member Functions inherited from wpi::nt::GenericSubscriber
	GenericSubscriber ()=default
	GenericSubscriber (NT_Subscriber handle)
	Construct from a subscriber handle; recommended to use Topic::GenericSubscribe() instead.
ValueType	Get () const
	Get the last published 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< TimestampedValueType >	ReadQueue ()
	Get an array of all value changes since the last call to ReadQueue.
TopicType	GetTopic () const
	Get the corresponding topic.
Public Member Functions inherited from wpi::nt::Subscriber
virtual	~Subscriber ()
	Subscriber (const Subscriber &)=delete
Subscriber &	operator= (const Subscriber &)=delete
	Subscriber (Subscriber &&rhs)
Subscriber &	operator= (Subscriber &&rhs)
	operator bool () const
	Determines if the native handle is valid.
NT_Subscriber	GetHandle () const
	Gets the native handle for the subscriber.
bool	Exists () const
	Determines if the topic is currently being published.
int64_t	GetLastChange () const
	Gets the last time the value was changed.
Topic	GetTopic () const
	Gets the subscribed-to topic.
Public Member Functions inherited from wpi::nt::GenericPublisher
	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 wpi::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 wpi::nt::Subscriber
	Subscriber ()=default
	Subscriber (NT_Subscriber handle)
Protected Member Functions inherited from wpi::nt::Publisher
	Publisher ()=default
	Publisher (NT_Publisher handle)
Protected Attributes inherited from wpi::nt::Subscriber
NT_Subscriber	m_subHandle {0}
Protected Attributes inherited from wpi::nt::Publisher
NT_Publisher	m_pubHandle {0}
	NetworkTables handle.

Detailed Description

NetworkTables generic entry.

Note: Unlike NetworkTableEntry, the entry goes away when this is destroyed.

Member Typedef Documentation

◆ ParamType

using wpi::nt::GenericEntry::ParamType = const Value&

◆ PublisherType

using wpi::nt::GenericEntry::PublisherType = GenericPublisher

◆ SubscriberType

using wpi::nt::GenericEntry::SubscriberType = GenericSubscriber

◆ TimestampedValueType

using wpi::nt::GenericEntry::TimestampedValueType = Value

◆ TopicType

using wpi::nt::GenericEntry::TopicType = Topic

◆ ValueType

using wpi::nt::GenericEntry::ValueType = Value

Constructor & Destructor Documentation

◆ GenericEntry() [1/2]

wpi::nt::GenericEntry::GenericEntry ( )

default

◆ GenericEntry() [2/2]

wpi::nt::GenericEntry::GenericEntry ( NT_Entry handle )

inlineexplicit

Construct from an entry handle; recommended to use RawTopic::GetEntry() instead.

Parameters

handle Native handle

Member Function Documentation

◆ GetHandle()

NT_Entry wpi::nt::GenericEntry::GetHandle ( ) const

inline

Gets the native handle for the entry.

Returns: Native handle

◆ GetTopic()

TopicType wpi::nt::GenericEntry::GetTopic ( ) const

inline

Get the corresponding topic.

Returns: Topic

◆ operator bool()

wpi::nt::GenericEntry::operator bool ( ) const

inlineexplicit

Determines if the native handle is valid.

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

◆ Unpublish()

void wpi::nt::GenericEntry::Unpublish ( )

inline

Stops publishing the entry if it's published.

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

wpi/nt/GenericEntry.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParamType

◆ PublisherType

◆ SubscriberType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ GenericEntry() [1/2]

◆ GenericEntry() [2/2]

Member Function Documentation

◆ GetHandle()

◆ GetTopic()

◆ operator bool()

◆ Unpublish()