WPILibC++ 2024.3.2
nt::UnitPublisher< T > Class Template Reference

NetworkTables unit-typed publisher. More...

#include <networktables/UnitTopic.h>

Inheritance diagram for nt::UnitPublisher< T >:
nt::Publisher nt::UnitEntry< T >

Public Types

using TopicType = UnitTopic< T >
 
using ValueType = T
 
using ParamType = T
 
using TimestampedValueType = TimestampedUnit< T >
 

Public Member Functions

 UnitPublisher ()=default
 
 UnitPublisher (NT_Publisher handle)
 Construct from a publisher handle; recommended to use UnitTopic::Publish() instead. More...
 
void Set (ParamType value, int64_t time=0)
 Publish a new value. More...
 
void SetDefault (ParamType value)
 Publish a default value. More...
 
TopicType GetTopic () const
 Get the corresponding topic. More...
 
- Public Member Functions inherited from nt::Publisher
virtual ~Publisher ()
 
 Publisher (const Publisher &)=delete
 
Publisheroperator= (const Publisher &)=delete
 
 Publisher (Publisher &&)
 
Publisheroperator= (Publisher &&)
 
 operator bool () const
 Determines if the native handle is valid. More...
 
NT_Publisher GetHandle () const
 Gets the native handle for the publisher. More...
 
Topic GetTopic () const
 Gets the published-to topic. More...
 

Additional Inherited Members

- Protected Member Functions inherited from nt::Publisher
 Publisher ()=default
 
 Publisher (NT_Publisher handle)
 
- Protected Attributes inherited from nt::Publisher
NT_Publisher m_pubHandle {0}
 NetworkTables handle. More...
 

Detailed Description

template<typename T>
class nt::UnitPublisher< T >

NetworkTables unit-typed publisher.

Template Parameters
Tunit type, e.g. units::meter_t

Member Typedef Documentation

◆ ParamType

template<typename T >
using nt::UnitPublisher< T >::ParamType = T

◆ TimestampedValueType

template<typename T >
using nt::UnitPublisher< T >::TimestampedValueType = TimestampedUnit<T>

◆ TopicType

template<typename T >
using nt::UnitPublisher< T >::TopicType = UnitTopic<T>

◆ ValueType

template<typename T >
using nt::UnitPublisher< T >::ValueType = T

Constructor & Destructor Documentation

◆ UnitPublisher() [1/2]

template<typename T >
nt::UnitPublisher< T >::UnitPublisher ( )
default

◆ UnitPublisher() [2/2]

template<typename T >
nt::UnitPublisher< T >::UnitPublisher ( NT_Publisher  handle)
inlineexplicit

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

Parameters
handleNative handle

Member Function Documentation

◆ GetTopic()

template<typename T >
UnitTopic< T > nt::UnitPublisher< T >::GetTopic
inline

Get the corresponding topic.

Returns
Topic

◆ Set()

template<typename T >
void nt::UnitPublisher< T >::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()

template<typename T >
void nt::UnitPublisher< T >::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 files: