WPILibC++ 2024.3.2
wpi::log::StructLogEntry< T, I > Class Template Reference

Log raw struct serializable objects. More...

#include <wpi/DataLog.h>

Inheritance diagram for wpi::log::StructLogEntry< T, I >:
wpi::log::DataLogEntry

Public Member Functions

 StructLogEntry ()=default
 
 StructLogEntry (DataLog &log, std::string_view name, I... info, int64_t timestamp=0)
 
 StructLogEntry (DataLog &log, std::string_view name, std::string_view metadata, I... info, int64_t timestamp=0)
 
void Append (const 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...
 

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

template<typename T, typename... I>
requires StructSerializable<T, I...>
class wpi::log::StructLogEntry< T, I >

Log raw struct serializable objects.

Constructor & Destructor Documentation

◆ StructLogEntry() [1/3]

template<typename T , typename... I>
wpi::log::StructLogEntry< T, I >::StructLogEntry ( )
default

◆ StructLogEntry() [2/3]

template<typename T , typename... I>
wpi::log::StructLogEntry< T, I >::StructLogEntry ( DataLog log,
std::string_view  name,
I...  info,
int64_t  timestamp = 0 
)
inline

◆ StructLogEntry() [3/3]

template<typename T , typename... I>
wpi::log::StructLogEntry< T, I >::StructLogEntry ( DataLog log,
std::string_view  name,
std::string_view  metadata,
I...  info,
int64_t  timestamp = 0 
)
inline

Member Function Documentation

◆ Append()

template<typename T , typename... I>
void wpi::log::StructLogEntry< T, I >::Append ( const 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)

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