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

NetworkTables subscriber. More...

#include <wpi/nt/Topic.hpp>

Inheritance diagram for wpi::nt::Subscriber:
wpi::nt::StructArraySubscriber< T, I... > wpi::nt::StructSubscriber< T, I... > wpi::nt::BooleanArraySubscriber wpi::nt::BooleanSubscriber wpi::nt::DoubleArraySubscriber wpi::nt::DoubleSubscriber wpi::nt::FloatArraySubscriber wpi::nt::FloatSubscriber wpi::nt::GenericSubscriber wpi::nt::IntegerArraySubscriber wpi::nt::IntegerSubscriber wpi::nt::ProtobufSubscriber< T > wpi::nt::RawSubscriber wpi::nt::StringArraySubscriber wpi::nt::StringSubscriber wpi::nt::StructArraySubscriber< T, I > wpi::nt::StructSubscriber< T, I > wpi::nt::UnitSubscriber< T >

Public Member Functions

virtual ~Subscriber ()
 Subscriber (const Subscriber &)=delete
Subscriberoperator= (const Subscriber &)=delete
 Subscriber (Subscriber &&rhs)
Subscriberoperator= (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.

Protected Member Functions

 Subscriber ()=default
 Subscriber (NT_Subscriber handle)

Protected Attributes

NT_Subscriber m_subHandle {0}

Detailed Description

NetworkTables subscriber.

Constructor & Destructor Documentation

◆ ~Subscriber()

virtual wpi::nt::Subscriber::~Subscriber ( )
inlinevirtual

◆ Subscriber() [1/4]

wpi::nt::Subscriber::Subscriber ( const Subscriber & )
delete

◆ Subscriber() [2/4]

wpi::nt::Subscriber::Subscriber ( Subscriber && rhs)
inline

◆ Subscriber() [3/4]

wpi::nt::Subscriber::Subscriber ( )
protecteddefault

◆ Subscriber() [4/4]

wpi::nt::Subscriber::Subscriber ( NT_Subscriber handle)
inlineexplicitprotected

Member Function Documentation

◆ Exists()

bool wpi::nt::Subscriber::Exists ( ) const
inline

Determines if the topic is currently being published.

Returns
True if the topic exists, false otherwise.

◆ GetHandle()

NT_Subscriber wpi::nt::Subscriber::GetHandle ( ) const
inline

Gets the native handle for the subscriber.

Returns
Native handle

◆ GetLastChange()

int64_t wpi::nt::Subscriber::GetLastChange ( ) const
inline

Gets the last time the value was changed.

Note: this is not atomic with Get(); use GetAtomic() to get both the value and last change as an atomic operation.

Returns
Topic last change time

◆ GetTopic()

Topic wpi::nt::Subscriber::GetTopic ( ) const
inline

Gets the subscribed-to topic.

Returns
Topic

◆ operator bool()

wpi::nt::Subscriber::operator bool ( ) const
inlineexplicit

Determines if the native handle is valid.

Returns
True if the native handle is valid, false otherwise.

◆ operator=() [1/2]

Subscriber & wpi::nt::Subscriber::operator= ( const Subscriber & )
delete

◆ operator=() [2/2]

Subscriber & wpi::nt::Subscriber::operator= ( Subscriber && rhs)
inline

Member Data Documentation

◆ m_subHandle

NT_Subscriber wpi::nt::Subscriber::m_subHandle {0}
protected

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