wpi::nt::BooleanArrayEntry Class Reference

NetworkTables BooleanArray entry. More...

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

Inheritance diagram for wpi::nt::BooleanArrayEntry:

Public Types
using	SubscriberType = BooleanArraySubscriber
using	PublisherType = BooleanArrayPublisher
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 Types inherited from wpi::nt::BooleanArraySubscriber
using	TopicType = BooleanArrayTopic
using	ValueType = std::vector<int>
using	ParamType = std::span<const int>
using	TimestampedValueType = TimestampedBooleanArray
using	SmallRetType = std::span<int>
using	SmallElemType = int
using	TimestampedValueViewType = TimestampedBooleanArrayView
Public Types inherited from wpi::nt::BooleanArrayPublisher
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
	BooleanArrayEntry ()=default
	BooleanArrayEntry (NT_Entry handle, ParamType defaultValue)
	Construct from an entry handle; recommended to use BooleanArrayTopic::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 wpi::nt::BooleanArraySubscriber
	BooleanArraySubscriber ()=default
	BooleanArraySubscriber (NT_Subscriber handle, ParamType defaultValue)
	Construct from a subscriber handle; recommended to use BooleanArrayTopic::Subscribe() instead.
ValueType	Get () const
	Get the last published value.
ValueType	Get (ParamType defaultValue) const
	Get the last published value.
SmallRetType	Get (wpi::util::SmallVectorImpl< SmallElemType > &buf) const
	Get the last published value.
SmallRetType	Get (wpi::util::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::util::SmallVectorImpl< SmallElemType > &buf) const
	Get the last published value along with its timestamp.
TimestampedValueViewType	GetAtomic (wpi::util::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 wpi::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 wpi::nt::BooleanArrayPublisher
	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
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::Subscriber
	Subscriber ()=default
	Subscriber (NT_Subscriber handle)
Protected Member Functions inherited from wpi::nt::Publisher
	Publisher ()=default
	Publisher (NT_Publisher handle)
Protected Attributes inherited from wpi::nt::Subscriber
NT_Subscriber	m_subHandle {0}
Protected Attributes inherited from wpi::nt::Publisher
NT_Publisher	m_pubHandle {0}
	NetworkTables handle.

Detailed Description

NetworkTables BooleanArray entry.

Note

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

Member Typedef Documentation

ParamType

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

PublisherType

using wpi::nt::BooleanArrayEntry::PublisherType = BooleanArrayPublisher

SmallElemType

using wpi::nt::BooleanArrayEntry::SmallElemType = int

SmallRetType

using wpi::nt::BooleanArrayEntry::SmallRetType = std::span<int>

SubscriberType

using wpi::nt::BooleanArrayEntry::SubscriberType = BooleanArraySubscriber

TimestampedValueType

using wpi::nt::BooleanArrayEntry::TimestampedValueType = TimestampedBooleanArray

TopicType

using wpi::nt::BooleanArrayEntry::TopicType = BooleanArrayTopic

ValueType

using wpi::nt::BooleanArrayEntry::ValueType = std::vector<int>

Constructor & Destructor Documentation

BooleanArrayEntry() [1/2]

wpi::nt::BooleanArrayEntry::BooleanArrayEntry ( )

default

BooleanArrayEntry() [2/2]

wpi::nt::BooleanArrayEntry::BooleanArrayEntry ( NT_Entry handle, ParamType defaultValue )

inline

Construct from an entry handle; recommended to use BooleanArrayTopic::GetEntry() instead.

Parameters

handle	Native handle
defaultValue	Default value

Member Function Documentation

GetHandle()

NT_Entry wpi::nt::BooleanArrayEntry::GetHandle ( ) const

inline

Gets the native handle for the entry.

Returns

Native handle

GetTopic()

BooleanArrayTopic wpi::nt::BooleanArrayEntry::GetTopic ( ) const

inline

Get the corresponding topic.

Returns

Topic

operator bool()

wpi::nt::BooleanArrayEntry::operator bool ( ) const

inlineexplicit

Determines if the native handle is valid.

Returns

True if the native handle is valid, false otherwise.

Unpublish()

void wpi::nt::BooleanArrayEntry::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/wpi/nt/BooleanArrayTopic.hpp