wpi::nt::BooleanArraySubscriber Class Reference

NetworkTables BooleanArray subscriber. More...

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

Inheritance diagram for wpi::nt::BooleanArraySubscriber:

Public Types
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 Member Functions
	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.

Additional Inherited Members
Protected Member Functions inherited from wpi::nt::Subscriber
	Subscriber ()=default
	Subscriber (NT_Subscriber handle)
Protected Attributes inherited from wpi::nt::Subscriber
NT_Subscriber	m_subHandle {0}

Detailed Description

NetworkTables BooleanArray subscriber.

Member Typedef Documentation

ParamType

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

SmallElemType

using wpi::nt::BooleanArraySubscriber::SmallElemType = int

SmallRetType

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

TimestampedValueType

using wpi::nt::BooleanArraySubscriber::TimestampedValueType = TimestampedBooleanArray

TimestampedValueViewType

using wpi::nt::BooleanArraySubscriber::TimestampedValueViewType = TimestampedBooleanArrayView

TopicType

using wpi::nt::BooleanArraySubscriber::TopicType = BooleanArrayTopic

ValueType

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

Constructor & Destructor Documentation

BooleanArraySubscriber() [1/2]

wpi::nt::BooleanArraySubscriber::BooleanArraySubscriber ( )

default

BooleanArraySubscriber() [2/2]

wpi::nt::BooleanArraySubscriber::BooleanArraySubscriber ( NT_Subscriber handle, ParamType defaultValue )

inline

Construct from a subscriber handle; recommended to use BooleanArrayTopic::Subscribe() instead.

Parameters

handle	Native handle
defaultValue	Default value

Member Function Documentation

Get() [1/4]

ValueType wpi::nt::BooleanArraySubscriber::Get ( ) const

inline

Get the last published value.

If no value has been published, returns the stored default value.

Returns

value

Get() [2/4]

ValueType wpi::nt::BooleanArraySubscriber::Get ( ParamType defaultValue ) const

inline

Get the last published value.

If no value has been published, returns the passed defaultValue.

Parameters

defaultValue

default value to return if no value has been published

Returns

value

Get() [3/4]

SmallRetType wpi::nt::BooleanArraySubscriber::Get ( wpi::util::SmallVectorImpl< SmallElemType > & buf ) const

inline

Get the last published value.

If no value has been published, returns the stored default value.

Parameters

buf	storage for returned value

Returns

value

Get() [4/4]

SmallRetType wpi::nt::BooleanArraySubscriber::Get ( wpi::util::SmallVectorImpl< SmallElemType > & buf, ParamType defaultValue ) const

inline

Get the last published value.

If no value has been published, returns the passed defaultValue.

Parameters

buf	storage for returned value
defaultValue	default value to return if no value has been published

Returns

value

GetAtomic() [1/4]

TimestampedValueType wpi::nt::BooleanArraySubscriber::GetAtomic ( ) const

inline

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.

Returns

timestamped value

GetAtomic() [2/4]

TimestampedValueType wpi::nt::BooleanArraySubscriber::GetAtomic ( ParamType defaultValue ) const

inline

Get the last published value along with its timestamp.

If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters

defaultValue

default value to return if no value has been published

Returns

timestamped value

GetAtomic() [3/4]

TimestampedValueViewType wpi::nt::BooleanArraySubscriber::GetAtomic ( wpi::util::SmallVectorImpl< SmallElemType > & buf ) const

inline

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.

Parameters

buf	storage for returned value

Returns

timestamped value

GetAtomic() [4/4]

TimestampedValueViewType wpi::nt::BooleanArraySubscriber::GetAtomic ( wpi::util::SmallVectorImpl< SmallElemType > & buf, ParamType defaultValue ) const

inline

Get the last published value along with its timestamp.

If no value has been published, returns the passed defaultValue and a timestamp of 0.

Parameters

buf	storage for returned value
defaultValue	default value to return if no value has been published

Returns

timestamped value

GetTopic()

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

inline

Get the corresponding topic.

Returns

Topic

ReadQueue()

std::vector< TimestampedValueType > wpi::nt::BooleanArraySubscriber::ReadQueue ( )

inline

Get an array of all value changes since the last call to ReadQueue.

Also provides a timestamp for each value.

Note

The "poll storage" subscribe option can be used to set the queue depth.

Returns

Array of timestamped values; empty array if no new changes have been published since the previous call.

---

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