wpi::nt::StringArrayPublisher Class Reference

NetworkTables StringArray publisher. More...

#include </home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/wpi/nt/StringArrayTopic.hpp>

Inheritance diagram for wpi::nt::StringArrayPublisher:

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

Public Member Functions
	StringArrayPublisher ()=default
	StringArrayPublisher (NT_Publisher handle)
	Construct from a publisher handle; recommended to use StringArrayTopic::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 wpi::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 wpi::nt::Publisher
	Publisher ()=default
	Publisher (NT_Publisher handle)
Protected Attributes inherited from wpi::nt::Publisher
NT_Publisher	m_pubHandle {0}
	NetworkTables handle.

Detailed Description

NetworkTables StringArray publisher.

Member Typedef Documentation

ParamType

using wpi::nt::StringArrayPublisher::ParamType = std::span<const std::string>

TimestampedValueType

using wpi::nt::StringArrayPublisher::TimestampedValueType = TimestampedStringArray

TopicType

using wpi::nt::StringArrayPublisher::TopicType = StringArrayTopic

ValueType

using wpi::nt::StringArrayPublisher::ValueType = std::vector<std::string>

Constructor & Destructor Documentation

StringArrayPublisher() [1/2]

wpi::nt::StringArrayPublisher::StringArrayPublisher ( )

default

StringArrayPublisher() [2/2]

wpi::nt::StringArrayPublisher::StringArrayPublisher ( NT_Publisher handle )

inlineexplicit

Construct from a publisher handle; recommended to use StringArrayTopic::Publish() instead.

Parameters

handle

Native handle

Member Function Documentation

GetTopic()

StringArrayTopic wpi::nt::StringArrayPublisher::GetTopic ( ) const

inline

Get the corresponding topic.

Returns

Topic

Set()

void wpi::nt::StringArrayPublisher::Set ( ParamType value, int64_t time = 0 )

inline

Publish a new value.

Parameters

value	value to publish
time	timestamp; 0 indicates current NT time should be used

SetDefault()

void wpi::nt::StringArrayPublisher::SetDefault ( ParamType value )

inline

Publish a default value.

On reconnect, a default value will never be used in preference to a published value.

Parameters

value

value

---

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

• /home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/wpi/nt/StringArrayTopic.hpp