NetworkTables String entry. More...

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

Inheritance diagram for nt::StringEntry:

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.

	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::StringSubscriber
	StringSubscriber ()=default

	StringSubscriber (NT_Subscriber handle, ParamType defaultValue)
	Construct from a subscriber handle; recommended to use StringTopic::Subscribe() instead.

ValueType	Get () const
	Get the last published value.

ValueType	Get (ParamType defaultValue) const
	Get the last published value.

SmallRetType	Get (wpi::SmallVectorImpl< SmallElemType > &buf) const
	Get the last published value.

SmallRetType	Get (wpi::SmallVectorImpl< SmallElemType > &buf, ParamType defaultValue) const
	Get the last published value.

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.

TimestampedValueType	GetAtomic (ParamType defaultValue) const
	Get the last published value along with its timestamp.

TimestampedValueViewType	GetAtomic (wpi::SmallVectorImpl< SmallElemType > &buf) const
	Get the last published value along with its timestamp.

TimestampedValueViewType	GetAtomic (wpi::SmallVectorImpl< SmallElemType > &buf, ParamType defaultValue) const
	Get the last published value along with its timestamp.

std::vector< TimestampedValueType >	ReadQueue ()
	Get an array of all 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::StringPublisher
	StringPublisher ()=default

	StringPublisher (NT_Publisher handle)
	Construct from a publisher handle; recommended to use StringTopic::Publish() instead.

void	Set (ParamType value, int64_t time=0)
	Publish a new value.

void	SetDefault (ParamType 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.

Detailed Description

NetworkTables String entry.

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

Member Typedef Documentation

◆ ParamType

using nt::StringEntry::ParamType = std::string_view

◆ PublisherType

using nt::StringEntry::PublisherType = StringPublisher

◆ SmallElemType

using nt::StringEntry::SmallElemType = char

◆ SmallRetType

using nt::StringEntry::SmallRetType = std::string_view

◆ SubscriberType

using nt::StringEntry::SubscriberType = StringSubscriber

◆ TimestampedValueType

using nt::StringEntry::TimestampedValueType = TimestampedString

◆ TopicType

using nt::StringEntry::TopicType = StringTopic

◆ 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

handle	Native handle
defaultValue	Default 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 file:

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParamType

◆ PublisherType

◆ SmallElemType

◆ SmallRetType

◆ SubscriberType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ StringEntry() [1/2]

◆ StringEntry() [2/2]

Member Function Documentation

◆ GetHandle()

◆ GetTopic()

◆ operator bool()

◆ Unpublish()