WPILibC++ 2024.3.2
nt::StringEntry Class Referencefinal

NetworkTables String entry. More...

#include </home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/networktables/StringTopic.h>

Inheritance diagram for nt::StringEntry:
nt::StringSubscriber nt::StringPublisher nt::Subscriber nt::Publisher

Public Types

using SubscriberType = StringSubscriber
 
using PublisherType = StringPublisher
 
using TopicType = StringTopic
 
using ValueType = std::string
 
using ParamType = std::string_view
 
using SmallRetType = std::string_view
 
using SmallElemType = char
 
using TimestampedValueType = TimestampedString
 
- Public Types inherited from nt::StringSubscriber
using TopicType = StringTopic
 
using ValueType = std::string
 
using ParamType = std::string_view
 
using TimestampedValueType = TimestampedString
 
using SmallRetType = std::string_view
 
using SmallElemType = char
 
using TimestampedValueViewType = TimestampedStringView
 
- Public Types inherited from nt::StringPublisher
using TopicType = StringTopic
 
using ValueType = std::string
 
using ParamType = std::string_view
 
using SmallRetType = std::string_view
 
using SmallElemType = char
 
using TimestampedValueType = TimestampedString
 

Public Member Functions

 StringEntry ()=default
 
 StringEntry (NT_Entry handle, ParamType defaultValue)
 Construct from an entry handle; recommended to use StringTopic::GetEntry() instead. More...
 
 operator bool () const
 Determines if the native handle is valid. More...
 
NT_Entry GetHandle () const
 Gets the native handle for the entry. More...
 
TopicType GetTopic () const
 Get the corresponding topic. More...
 
void Unpublish ()
 Stops publishing the entry if it's published. More...
 
- Public Member Functions inherited from nt::StringSubscriber
 StringSubscriber ()=default
 
 StringSubscriber (NT_Subscriber handle, ParamType defaultValue)
 Construct from a subscriber handle; recommended to use StringTopic::Subscribe() instead. More...
 
ValueType Get () const
 Get the last published value. More...
 
ValueType Get (ParamType defaultValue) const
 Get the last published value. More...
 
SmallRetType Get (wpi::SmallVectorImpl< SmallElemType > &buf) const
 Get the last published value. More...
 
SmallRetType Get (wpi::SmallVectorImpl< SmallElemType > &buf, ParamType defaultValue) const
 Get the last published value. More...
 
TimestampedValueType GetAtomic () const
 Get the last published value along with its timestamp If no value has been published, returns the stored default value and a timestamp of 0. More...
 
TimestampedValueType GetAtomic (ParamType defaultValue) const
 Get the last published value along with its timestamp. More...
 
TimestampedValueViewType GetAtomic (wpi::SmallVectorImpl< SmallElemType > &buf) const
 Get the last published value along with its timestamp. More...
 
TimestampedValueViewType GetAtomic (wpi::SmallVectorImpl< SmallElemType > &buf, ParamType defaultValue) const
 Get the last published value along with its timestamp. More...
 
std::vector< TimestampedValueTypeReadQueue ()
 Get an array of all value changes since the last call to ReadQueue. More...
 
TopicType GetTopic () const
 Get the corresponding topic. More...
 
- Public Member Functions inherited from nt::Subscriber
virtual ~Subscriber ()
 
 Subscriber (const Subscriber &)=delete
 
Subscriberoperator= (const Subscriber &)=delete
 
 Subscriber (Subscriber &&)
 
Subscriberoperator= (Subscriber &&)
 
 operator bool () const
 Determines if the native handle is valid. More...
 
NT_Subscriber GetHandle () const
 Gets the native handle for the subscriber. More...
 
bool Exists () const
 Determines if the topic is currently being published. More...
 
int64_t GetLastChange () const
 Gets the last time the value was changed. More...
 
Topic GetTopic () const
 Gets the subscribed-to topic. More...
 
- Public Member Functions inherited from nt::StringPublisher
 StringPublisher ()=default
 
 StringPublisher (NT_Publisher handle)
 Construct from a publisher handle; recommended to use StringTopic::Publish() instead. More...
 
void Set (ParamType value, int64_t time=0)
 Publish a new value. More...
 
void SetDefault (ParamType value)
 Publish a default value. More...
 
TopicType GetTopic () const
 Get the corresponding topic. More...
 
- Public Member Functions inherited from nt::Publisher
virtual ~Publisher ()
 
 Publisher (const Publisher &)=delete
 
Publisheroperator= (const Publisher &)=delete
 
 Publisher (Publisher &&)
 
Publisheroperator= (Publisher &&)
 
 operator bool () const
 Determines if the native handle is valid. More...
 
NT_Publisher GetHandle () const
 Gets the native handle for the publisher. More...
 
Topic GetTopic () const
 Gets the published-to topic. More...
 

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. More...
 

Detailed Description

NetworkTables String entry.

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

Member Typedef Documentation

◆ ParamType

◆ PublisherType

◆ SmallElemType

◆ SmallRetType

◆ SubscriberType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

using nt::StringEntry::ValueType = std::string

Constructor & Destructor Documentation

◆ StringEntry() [1/2]

nt::StringEntry::StringEntry ( )
default

◆ StringEntry() [2/2]

nt::StringEntry::StringEntry ( NT_Entry  handle,
ParamType  defaultValue 
)
inline

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

Parameters
handleNative handle
defaultValueDefault value

Member Function Documentation

◆ GetHandle()

NT_Entry nt::StringEntry::GetHandle ( ) const
inline

Gets the native handle for the entry.

Returns
Native handle

◆ GetTopic()

StringTopic nt::StringEntry::GetTopic ( ) const
inline

Get the corresponding topic.

Returns
Topic

◆ operator bool()

nt::StringEntry::operator bool ( ) const
inlineexplicit

Determines if the native handle is valid.

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

◆ Unpublish()

void nt::StringEntry::Unpublish ( )
inline

Stops publishing the entry if it's published.


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