![]() |
WPILibC++ 2025.3.2
|
NetworkTables protobuf-encoded value entry. More...
#include <networktables/ProtobufTopic.h>
Public Types | |
| using | SubscriberType = ProtobufSubscriber<T> |
| using | PublisherType = ProtobufPublisher<T> |
| using | TopicType = ProtobufTopic<T> |
| using | ValueType = T |
| using | ParamType = const T& |
| using | TimestampedValueType = Timestamped<T> |
Public Types inherited from nt::ProtobufSubscriber< T > | |
| using | TopicType = ProtobufTopic<T> |
| using | ValueType = T |
| using | ParamType = const T& |
| using | TimestampedValueType = Timestamped<T> |
Public Types inherited from nt::ProtobufPublisher< T > | |
| using | TopicType = ProtobufTopic<T> |
| using | ValueType = T |
| using | ParamType = const T& |
| using | TimestampedValueType = Timestamped<T> |
Public Member Functions | |
| ProtobufEntry ()=default | |
| ProtobufEntry (NT_Entry handle, wpi::ProtobufMessage< T > msg, T defaultValue) | |
| Construct from an entry handle; recommended to use ProtobufTopic::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 nt::ProtobufSubscriber< T > | |
| ProtobufSubscriber ()=default | |
| ProtobufSubscriber (NT_Subscriber handle, wpi::ProtobufMessage< T > msg, T defaultValue) | |
| Construct from a subscriber handle; recommended to use ProtobufTopic::Subscribe() instead. | |
| ProtobufSubscriber (const ProtobufSubscriber &)=delete | |
| ProtobufSubscriber & | operator= (const ProtobufSubscriber &)=delete |
| ProtobufSubscriber (ProtobufSubscriber &&rhs) | |
| ProtobufSubscriber & | operator= (ProtobufSubscriber &&rhs) |
| ValueType | Get () const |
| Get the last published value. | |
| ValueType | Get (const T &defaultValue) const |
| Get the last published value. | |
| bool | GetInto (T *out) |
| Get the last published value, replacing the contents in place of an existing object. | |
| TimestampedValueType | GetAtomic () const |
| Get the last published value along with its timestamp If no value has been published or the value cannot be unpacked, returns the stored default value and a timestamp of 0. | |
| TimestampedValueType | GetAtomic (const T &defaultValue) const |
| Get the last published value along with its timestamp. | |
| std::vector< TimestampedValueType > | ReadQueue () |
| Get an array of all valid value changes since the last call to ReadQueue. | |
| TopicType | GetTopic () const |
| Get the corresponding topic. | |
Public Member Functions inherited from 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 nt::ProtobufPublisher< T > | |
| ProtobufPublisher ()=default | |
| ProtobufPublisher (NT_Publisher handle, wpi::ProtobufMessage< T > msg) | |
| Construct from a publisher handle; recommended to use ProtobufTopic::Publish() instead. | |
| ProtobufPublisher (const ProtobufPublisher &)=delete | |
| ProtobufPublisher & | operator= (const ProtobufPublisher &)=delete |
| ProtobufPublisher (ProtobufPublisher &&rhs) | |
| ProtobufPublisher & | operator= (ProtobufPublisher &&rhs) |
| void | Set (const T &value, int64_t time=0) |
| Publish a new value. | |
| void | SetDefault (const T &value) |
| Publish a default value. | |
| 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::Subscriber | |
| Subscriber ()=default | |
| Subscriber (NT_Subscriber handle) | |
Protected Member Functions inherited from nt::Publisher | |
| Publisher ()=default | |
| Publisher (NT_Publisher handle) | |
Protected Attributes inherited from nt::Subscriber | |
| NT_Subscriber | m_subHandle {0} |
Protected Attributes inherited from nt::Publisher | |
| NT_Publisher | m_pubHandle {0} |
| NetworkTables handle. | |
NetworkTables protobuf-encoded value entry.
| using nt::ProtobufEntry< T >::ParamType = const T& |
| using nt::ProtobufEntry< T >::PublisherType = ProtobufPublisher<T> |
| using nt::ProtobufEntry< T >::SubscriberType = ProtobufSubscriber<T> |
| using nt::ProtobufEntry< T >::TimestampedValueType = Timestamped<T> |
| using nt::ProtobufEntry< T >::TopicType = ProtobufTopic<T> |
| using nt::ProtobufEntry< T >::ValueType = T |
|
default |
|
inline |
Construct from an entry handle; recommended to use ProtobufTopic::GetEntry() instead.
| handle | Native handle |
| msg | Protobuf message |
| defaultValue | Default value |
|
inline |
Gets the native handle for the entry.
|
inline |
Get the corresponding topic.
|
inlineexplicit |
Determines if the native handle is valid.
|
inline |
Stops publishing the entry if it's published.