nt::StringArraySubscriber Class Reference

NetworkTables StringArray subscriber. More...

#include <networktables/StringArrayTopic.h>

Inheritance diagram for nt::StringArraySubscriber:

Public Types
using	TopicType = StringArrayTopic
using	ValueType = std::vector< std::string >
using	ParamType = std::span< const std::string >
using	TimestampedValueType = TimestampedStringArray

Public Member Functions
	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< TimestampedValueType >	ReadQueue ()
	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
Subscriber &	operator= (const Subscriber &)=delete
	Subscriber (Subscriber &&)
Subscriber &	operator= (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...

Additional Inherited Members
Protected Member Functions inherited from nt::Subscriber
	Subscriber ()=default
	Subscriber (NT_Subscriber handle)
Protected Attributes inherited from nt::Subscriber
NT_Subscriber	m_subHandle {0}

Detailed Description

NetworkTables StringArray subscriber.

Member Typedef Documentation

ParamType

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

TimestampedValueType

using nt::StringArraySubscriber::TimestampedValueType = TimestampedStringArray

TopicType

using nt::StringArraySubscriber::TopicType = StringArrayTopic

ValueType

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

Constructor & Destructor Documentation

StringArraySubscriber() [1/2]

nt::StringArraySubscriber::StringArraySubscriber ( )

default

StringArraySubscriber() [2/2]

nt::StringArraySubscriber::StringArraySubscriber	(	NT_Subscriber	handle,
		ParamType	defaultValue
	)

Construct from a subscriber handle; recommended to use StringArrayTopic::Subscribe() instead.

Parameters

handle	Native handle
defaultValue	Default value

Member Function Documentation

Get() [1/2]

std::vector< std::string > nt::StringArraySubscriber::Get ( ) const

inline

Get the last published value.

If no value has been published, returns the stored default value.

Returns

value

Get() [2/2]

ValueType nt::StringArraySubscriber::Get

(

ParamType

defaultValue

)

const

Get the last published value.

If no value has been published, returns the passed defaultValue.

Parameters

defaultValue

default value to return if no value has been published

Returns

value

GetAtomic() [1/2]

TimestampedStringArray nt::StringArraySubscriber::GetAtomic ( ) const

inline

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.

Returns

timestamped value

GetAtomic() [2/2]

TimestampedValueType nt::StringArraySubscriber::GetAtomic

(

ParamType

defaultValue

)

const

Get the last published value along with its timestamp.

If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters

defaultValue

default value to return if no value has been published

Returns

timestamped value

GetTopic()

StringArrayTopic nt::StringArraySubscriber::GetTopic ( ) const

inline

Get the corresponding topic.

Returns

Topic

ReadQueue()

std::vector< TimestampedStringArray > nt::StringArraySubscriber::ReadQueue ( )

inline

Get an array of all value changes since the last call to ReadQueue.

Also provides a timestamp for each value.

Note

The "poll storage" subscribe option can be used to set the queue depth.

Returns

Array of timestamped values; empty array if no new changes have been published since the previous call.

---

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

• networktables/StringArrayTopic.h
• networktables/StringArrayTopic.inc