WPILibC++ 2023.4.3
nt::StringArrayEntry Class Referencefinal

NetworkTables StringArray entry. More...

#include <networktables/StringArrayTopic.h>

Inheritance diagram for nt::StringArrayEntry:
nt::StringArraySubscriber nt::StringArrayPublisher nt::Subscriber nt::Publisher

Public Types

using SubscriberType = StringArraySubscriber
 
using PublisherType = StringArrayPublisher
 
using TopicType = StringArrayTopic
 
using ValueType = std::vector< std::string >
 
using ParamType = std::span< const std::string >
 
using TimestampedValueType = TimestampedStringArray
 
- Public Types inherited from nt::StringArraySubscriber
using TopicType = StringArrayTopic
 
using ValueType = std::vector< std::string >
 
using ParamType = std::span< const std::string >
 
using TimestampedValueType = TimestampedStringArray
 
- Public Types inherited from nt::StringArrayPublisher
using TopicType = StringArrayTopic
 
using ValueType = std::vector< std::string >
 
using ParamType = std::span< const std::string >
 
using TimestampedValueType = TimestampedStringArray
 

Public Member Functions

 StringArrayEntry ()=default
 
 StringArrayEntry (NT_Entry handle, ParamType defaultValue)
 Construct from an entry handle; recommended to use StringArrayTopic::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::StringArraySubscriber
 StringArraySubscriber ()=default
 
 StringArraySubscriber (NT_Subscriber handle, ParamType defaultValue)
 Construct from a subscriber handle; recommended to use StringArrayTopic::Subscribe() instead. More...
 
ValueType Get () const
 Get the last published value. More...
 
ValueType Get (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...
 
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::StringArrayPublisher
 StringArrayPublisher ()=default
 
 StringArrayPublisher (NT_Publisher handle)
 Construct from a publisher handle; recommended to use StringArrayTopic::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}
 

Detailed Description

NetworkTables StringArray entry.

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

Member Typedef Documentation

◆ ParamType

using nt::StringArrayEntry::ParamType = std::span<const std::string>

◆ PublisherType

◆ SubscriberType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

using nt::StringArrayEntry::ValueType = std::vector<std::string>

Constructor & Destructor Documentation

◆ StringArrayEntry() [1/2]

nt::StringArrayEntry::StringArrayEntry ( )
default

◆ StringArrayEntry() [2/2]

nt::StringArrayEntry::StringArrayEntry ( NT_Entry  handle,
ParamType  defaultValue 
)

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

Parameters
handleNative handle
defaultValueDefault value

Member Function Documentation

◆ GetHandle()

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

Gets the native handle for the entry.

Returns
Native handle

◆ GetTopic()

StringArrayTopic nt::StringArrayEntry::GetTopic ( ) const
inline

Get the corresponding topic.

Returns
Topic

◆ operator bool()

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

Determines if the native handle is valid.

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

◆ Unpublish()

void nt::StringArrayEntry::Unpublish ( )
inline

Stops publishing the entry if it's published.


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