WPILibC++ 2024.3.2
nt::StringArrayPublisher Class Reference

NetworkTables StringArray publisher. More...

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

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

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. 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::Publisher
 Publisher ()=default
 
 Publisher (NT_Publisher handle)
 
- Protected Attributes inherited from nt::Publisher
NT_Publisher m_pubHandle {0}
 NetworkTables handle. More...
 

Detailed Description

NetworkTables StringArray publisher.

Member Typedef Documentation

◆ ParamType

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

◆ TimestampedValueType

◆ TopicType

◆ ValueType

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

Constructor & Destructor Documentation

◆ StringArrayPublisher() [1/2]

nt::StringArrayPublisher::StringArrayPublisher ( )
default

◆ StringArrayPublisher() [2/2]

nt::StringArrayPublisher::StringArrayPublisher ( NT_Publisher  handle)
inlineexplicit

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

Parameters
handleNative handle

Member Function Documentation

◆ GetTopic()

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

Get the corresponding topic.

Returns
Topic

◆ Set()

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

Publish a new value.

Parameters
valuevalue to publish
timetimestamp; 0 indicates current NT time should be used

◆ SetDefault()

void 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
valuevalue

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