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

Log array of integer values. More...

#include <wpi/DataLog.h>

Inheritance diagram for wpi::log::IntegerArrayLogEntry:
wpi::log::DataLogEntry

Public Member Functions

 IntegerArrayLogEntry ()=default
 
 IntegerArrayLogEntry (DataLog &log, std::string_view name, int64_t timestamp=0)
 
 IntegerArrayLogEntry (DataLog &log, std::string_view name, std::string_view metadata, int64_t timestamp=0)
 
void Append (std::span< const int64_t > arr, int64_t timestamp=0)
 Appends a record to the log. More...
 
void Append (std::initializer_list< int64_t > arr, 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 const char * kDataType = "int64[]"
 

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 array of integer values.

Constructor & Destructor Documentation

◆ IntegerArrayLogEntry() [1/3]

wpi::log::IntegerArrayLogEntry::IntegerArrayLogEntry ( )
default

◆ IntegerArrayLogEntry() [2/3]

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

◆ IntegerArrayLogEntry() [3/3]

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

Member Function Documentation

◆ Append() [1/2]

void wpi::log::IntegerArrayLogEntry::Append ( std::initializer_list< int64_t >  arr,
int64_t  timestamp = 0 
)
inline

Appends a record to the log.

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

◆ Append() [2/2]

void wpi::log::IntegerArrayLogEntry::Append ( std::span< const int64_t >  arr,
int64_t  timestamp = 0 
)
inline

Appends a record to the log.

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

Member Data Documentation

◆ kDataType

constexpr const char* wpi::log::IntegerArrayLogEntry::kDataType = "int64[]"
staticconstexpr

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