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

NetworkTables Raw publisher. More...

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

Inheritance diagram for wpi::nt::RawPublisher:
wpi::nt::Publisher wpi::nt::RawEntry

Public Types

using TopicType = RawTopic
using ValueType = std::vector<uint8_t>
using ParamType = std::span<const uint8_t>
using SmallRetType = std::span<uint8_t>
using SmallElemType = uint8_t
using TimestampedValueType = TimestampedRaw

Public Member Functions

 RawPublisher ()=default
 RawPublisher (NT_Publisher handle)
 Construct from a publisher handle; recommended to use RawTopic::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
Publisheroperator= (const Publisher &)=delete
 Publisher (Publisher &&rhs)
Publisheroperator= (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::Publisher
 Publisher ()=default
 Publisher (NT_Publisher handle)
Protected Attributes inherited from wpi::nt::Publisher
NT_Publisher m_pubHandle {0}
 NetworkTables handle.

Detailed Description

NetworkTables Raw publisher.

Member Typedef Documentation

◆ ParamType

using wpi::nt::RawPublisher::ParamType = std::span<const uint8_t>

◆ SmallElemType

◆ SmallRetType

using wpi::nt::RawPublisher::SmallRetType = std::span<uint8_t>

◆ TimestampedValueType

◆ TopicType

◆ ValueType

using wpi::nt::RawPublisher::ValueType = std::vector<uint8_t>

Constructor & Destructor Documentation

◆ RawPublisher() [1/2]

wpi::nt::RawPublisher::RawPublisher ( )
default

◆ RawPublisher() [2/2]

wpi::nt::RawPublisher::RawPublisher ( NT_Publisher handle)
inlineexplicit

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

Parameters
handleNative handle

Member Function Documentation

◆ GetTopic()

RawTopic wpi::nt::RawPublisher::GetTopic ( ) const
inline

Get the corresponding topic.

Returns
Topic

◆ Set()

void wpi::nt::RawPublisher::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()

void wpi::nt::RawPublisher::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 file:
  • /home/runner/work/allwpilib/allwpilib/ntcore/src/generated/main/native/include/wpi/nt/RawTopic.hpp