WPILibC++ 2024.3.2
wpi::log::RawLogEntry Class Reference

Log arbitrary byte data. More...

#include <wpi/DataLog.h>

Inheritance diagram for wpi::log::RawLogEntry:
wpi::log::DataLogEntry

Public Member Functions

 RawLogEntry ()=default
 
 RawLogEntry (DataLog &log, std::string_view name, int64_t timestamp=0)
 
 RawLogEntry (DataLog &log, std::string_view name, std::string_view metadata, int64_t timestamp=0)
 
 RawLogEntry (DataLog &log, std::string_view name, std::string_view metadata, std::string_view type, int64_t timestamp=0)
 
void Append (std::span< const uint8_t > data, int64_t timestamp=0)
 Appends a record to the log. More...
 
- Public Member Functions inherited from wpi::log::DataLogEntry
 DataLogEntry (const DataLogEntry &)=delete
 
DataLogEntryoperator= (const DataLogEntry &)=delete
 
 DataLogEntry (DataLogEntry &&rhs)
 
DataLogEntryoperator= (DataLogEntry &&rhs)
 
 operator bool () const
 
void SetMetadata (std::string_view metadata, int64_t timestamp=0)
 Updates the metadata for the entry. More...
 
void Finish (int64_t timestamp=0)
 Finishes the entry. More...
 

Static Public Attributes

static constexpr std::string_view kDataType = "raw"
 

Additional Inherited Members

- Protected Member Functions inherited from wpi::log::DataLogEntry
 DataLogEntry ()=default
 
 DataLogEntry (DataLog &log, std::string_view name, std::string_view type, std::string_view metadata={}, int64_t timestamp=0)
 
- Protected Attributes inherited from wpi::log::DataLogEntry
DataLogm_log = nullptr
 
int m_entry = 0
 

Detailed Description

Log arbitrary byte data.

Constructor & Destructor Documentation

◆ RawLogEntry() [1/4]

wpi::log::RawLogEntry::RawLogEntry ( )
default

◆ RawLogEntry() [2/4]

wpi::log::RawLogEntry::RawLogEntry ( DataLog log,
std::string_view  name,
int64_t  timestamp = 0 
)
inline

◆ RawLogEntry() [3/4]

wpi::log::RawLogEntry::RawLogEntry ( DataLog log,
std::string_view  name,
std::string_view  metadata,
int64_t  timestamp = 0 
)
inline

◆ RawLogEntry() [4/4]

wpi::log::RawLogEntry::RawLogEntry ( DataLog log,
std::string_view  name,
std::string_view  metadata,
std::string_view  type,
int64_t  timestamp = 0 
)
inline

Member Function Documentation

◆ Append()

void wpi::log::RawLogEntry::Append ( std::span< const uint8_t >  data,
int64_t  timestamp = 0 
)
inline

Appends a record to the log.

Parameters
dataData to record
timestampTime stamp (may be 0 to indicate now)

Member Data Documentation

◆ kDataType

constexpr std::string_view wpi::log::RawLogEntry::kDataType = "raw"
staticconstexpr

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