NetworkTables DoubleArray entry. More...

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

Inheritance diagram for wpi::nt::DoubleArrayEntry:

Public Types
using	SubscriberType = DoubleArraySubscriber
using	PublisherType = DoubleArrayPublisher
using	TopicType = DoubleArrayTopic
using	ValueType = std::vector<double>
using	ParamType = std::span<const double>
using	SmallRetType = std::span<double>
using	SmallElemType = double
using	TimestampedValueType = TimestampedDoubleArray
Public Types inherited from wpi::nt::DoubleArraySubscriber
using	TopicType = DoubleArrayTopic
using	ValueType = std::vector<double>
using	ParamType = std::span<const double>
using	TimestampedValueType = TimestampedDoubleArray
using	SmallRetType = std::span<double>
using	SmallElemType = double
using	TimestampedValueViewType = TimestampedDoubleArrayView
Public Types inherited from wpi::nt::DoubleArrayPublisher
using	TopicType = DoubleArrayTopic
using	ValueType = std::vector<double>
using	ParamType = std::span<const double>
using	SmallRetType = std::span<double>
using	SmallElemType = double
using	TimestampedValueType = TimestampedDoubleArray

Public Member Functions
	DoubleArrayEntry ()=default
	DoubleArrayEntry (NT_Entry handle, ParamType defaultValue)
	Construct from an entry handle; recommended to use DoubleArrayTopic::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::DoubleArraySubscriber
	DoubleArraySubscriber ()=default
	DoubleArraySubscriber (NT_Subscriber handle, ParamType defaultValue)
	Construct from a subscriber handle; recommended to use DoubleArrayTopic::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::DoubleArrayPublisher
	DoubleArrayPublisher ()=default
	DoubleArrayPublisher (NT_Publisher handle)
	Construct from a publisher handle; recommended to use DoubleArrayTopic::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 DoubleArray entry.

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

Member Typedef Documentation

◆ ParamType

using wpi::nt::DoubleArrayEntry::ParamType = std::span<const double>

◆ PublisherType

using wpi::nt::DoubleArrayEntry::PublisherType = DoubleArrayPublisher

◆ SmallElemType

using wpi::nt::DoubleArrayEntry::SmallElemType = double

◆ SmallRetType

using wpi::nt::DoubleArrayEntry::SmallRetType = std::span<double>

◆ SubscriberType

using wpi::nt::DoubleArrayEntry::SubscriberType = DoubleArraySubscriber

◆ TimestampedValueType

using wpi::nt::DoubleArrayEntry::TimestampedValueType = TimestampedDoubleArray

◆ TopicType

using wpi::nt::DoubleArrayEntry::TopicType = DoubleArrayTopic

◆ ValueType

using wpi::nt::DoubleArrayEntry::ValueType = std::vector<double>

Constructor & Destructor Documentation

◆ DoubleArrayEntry() [1/2]

wpi::nt::DoubleArrayEntry::DoubleArrayEntry ( )

default

◆ DoubleArrayEntry() [2/2]

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

inline

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

Parameters

handle	Native handle
defaultValue	Default value

Member Function Documentation

◆ GetHandle()

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

inline

Gets the native handle for the entry.

Returns: Native handle

◆ GetTopic()

DoubleArrayTopic wpi::nt::DoubleArrayEntry::GetTopic ( ) const

inline

Get the corresponding topic.

Returns: Topic

◆ operator bool()

wpi::nt::DoubleArrayEntry::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::DoubleArrayEntry::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/DoubleArrayTopic.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParamType

◆ PublisherType

◆ SmallElemType

◆ SmallRetType

◆ SubscriberType

◆ TimestampedValueType

◆ TopicType

◆ ValueType

Constructor & Destructor Documentation

◆ DoubleArrayEntry() [1/2]

◆ DoubleArrayEntry() [2/2]

Member Function Documentation

◆ GetHandle()

◆ GetTopic()

◆ operator bool()

◆ Unpublish()