WPILibC++ 2027.0.0-alpha-4
Loading...
Searching...
No Matches
wpi::nt::BooleanArrayPublisher Class Reference

NetworkTables BooleanArray publisher. More...

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

Inheritance diagram for wpi::nt::BooleanArrayPublisher:
wpi::nt::Publisher wpi::nt::BooleanArrayEntry

Public Types

using TopicType = BooleanArrayTopic
using ValueType = std::vector<int>
using ParamType = std::span<const int>
using SmallRetType = std::span<int>
using SmallElemType = int
using TimestampedValueType = TimestampedBooleanArray

Public Member Functions

 BooleanArrayPublisher ()=default
 BooleanArrayPublisher (NT_Publisher handle)
 Construct from a publisher handle; recommended to use BooleanArrayTopic::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
Publisheroperator= (const Publisher &)=delete
 Publisher (Publisher &&rhs)
Publisheroperator= (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 BooleanArray publisher.

Member Typedef Documentation

◆ ParamType

using wpi::nt::BooleanArrayPublisher::ParamType = std::span<const int>

◆ SmallElemType

◆ SmallRetType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ BooleanArrayPublisher() [1/2]

wpi::nt::BooleanArrayPublisher::BooleanArrayPublisher ( )
default

◆ BooleanArrayPublisher() [2/2]

wpi::nt::BooleanArrayPublisher::BooleanArrayPublisher ( NT_Publisher handle)
inlineexplicit

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

Parameters
handleNative handle

Member Function Documentation

◆ GetTopic()

BooleanArrayTopic wpi::nt::BooleanArrayPublisher::GetTopic ( ) const
inline

Get the corresponding topic.

Returns
Topic

◆ Set()

void wpi::nt::BooleanArrayPublisher::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 wpi::nt::BooleanArrayPublisher::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 file:
  • /home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/wpi/nt/BooleanArrayTopic.hpp