NetworkTables String subscriber. More...

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

Inheritance diagram for nt::StringSubscriber:

Public Types
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 Member Functions
	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< 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 String subscriber.

Member Typedef Documentation

◆ ParamType

using nt::StringSubscriber::ParamType = std::string_view

◆ SmallElemType

using nt::StringSubscriber::SmallElemType = char

◆ SmallRetType

using nt::StringSubscriber::SmallRetType = std::string_view

◆ TimestampedValueType

using nt::StringSubscriber::TimestampedValueType = TimestampedString

◆ TimestampedValueViewType

using nt::StringSubscriber::TimestampedValueViewType = TimestampedStringView

◆ TopicType

using nt::StringSubscriber::TopicType = StringTopic

◆ ValueType

using nt::StringSubscriber::ValueType = std::string

Constructor & Destructor Documentation

◆ StringSubscriber() [1/2]

nt::StringSubscriber::StringSubscriber ( )

default

◆ StringSubscriber() [2/2]

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

inline

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

Parameters

handle	Native handle
defaultValue	Default value

Member Function Documentation

◆ Get() [1/4]

std::string nt::StringSubscriber::Get ( ) const

inline

Get the last published value.

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

Returns: value

◆ Get() [2/4]

std::string nt::StringSubscriber::Get ( ParamType defaultValue ) const

inline

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

◆ Get() [3/4]

std::string_view nt::StringSubscriber::Get ( wpi::SmallVectorImpl< SmallElemType > & buf ) const

inline

Get the last published value.

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

Parameters

buf	storage for returned value

Returns: value

◆ Get() [4/4]

std::string_view nt::StringSubscriber::Get	(	wpi::SmallVectorImpl< SmallElemType > &	buf,
		ParamType	defaultValue
	)		const

inline

Get the last published value.

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

Parameters

buf	storage for returned value
defaultValue	default value to return if no value has been published

Returns: value

◆ GetAtomic() [1/4]

TimestampedString nt::StringSubscriber::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/4]

TimestampedString nt::StringSubscriber::GetAtomic ( ParamType defaultValue ) const

inline

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

◆ GetAtomic() [3/4]

TimestampedStringView nt::StringSubscriber::GetAtomic ( wpi::SmallVectorImpl< SmallElemType > & buf ) 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.

Parameters

buf	storage for returned value

Returns: timestamped value

◆ GetAtomic() [4/4]

TimestampedStringView nt::StringSubscriber::GetAtomic	(	wpi::SmallVectorImpl< SmallElemType > &	buf,
		ParamType	defaultValue
	)		const

inline

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

buf	storage for returned value
defaultValue	default value to return if no value has been published

Returns: timestamped value

◆ GetTopic()

StringTopic nt::StringSubscriber::GetTopic ( ) const

inline

Get the corresponding topic.

Returns: Topic

◆ ReadQueue()

std::vector< TimestampedString > nt::StringSubscriber::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:

/home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/networktables/StringTopic.h
/home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/networktables/StringTopic.inc

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParamType

◆ SmallElemType

◆ SmallRetType

◆ TimestampedValueType

◆ TimestampedValueViewType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ StringSubscriber() [1/2]

◆ StringSubscriber() [2/2]

Member Function Documentation

◆ Get() [1/4]

◆ Get() [2/4]

◆ Get() [3/4]

◆ Get() [4/4]

◆ GetAtomic() [1/4]

◆ GetAtomic() [2/4]

◆ GetAtomic() [3/4]

◆ GetAtomic() [4/4]

◆ GetTopic()

◆ ReadQueue()