wpi::log::FloatLogEntry Class Reference

Log float values. More...

#include <wpi/DataLog.h>

Inheritance diagram for wpi::log::FloatLogEntry:

Public Member Functions
	FloatLogEntry ()=default
	FloatLogEntry (DataLog &log, std::string_view name, int64_t timestamp=0)
	FloatLogEntry (DataLog &log, std::string_view name, std::string_view metadata, int64_t timestamp=0)
void	Append (float value, int64_t timestamp=0)
	Appends a record to the log.
void	Update (float value, int64_t timestamp=0)
	Updates the last value and appends a record to the log if it has changed.
Public Member Functions inherited from wpi::log::DataLogValueEntryImpl< float >
	DataLogValueEntryImpl (DataLogValueEntryImpl &&rhs)
DataLogValueEntryImpl &	operator= (DataLogValueEntryImpl &&rhs)
bool	HasLastValue () const
	Gets whether there is a last value.
std::optional< float >	GetLastValue () const
	Gets the last value.
Public Member Functions inherited from wpi::log::DataLogEntry
	DataLogEntry (const DataLogEntry &)=delete
DataLogEntry &	operator= (const DataLogEntry &)=delete
	DataLogEntry (DataLogEntry &&rhs)
DataLogEntry &	operator= (DataLogEntry &&rhs)
	operator bool () const
void	SetMetadata (std::string_view metadata, int64_t timestamp=0)
	Updates the metadata for the entry.
void	Finish (int64_t timestamp=0)
	Finishes the entry.

Static Public Attributes
static constexpr std::string_view	kDataType = "float"

Additional Inherited Members
Protected Member Functions inherited from wpi::log::DataLogValueEntryImpl< float >
	DataLogValueEntryImpl ()=default
	DataLogValueEntryImpl (DataLog &log, std::string_view name, std::string_view type, std::string_view metadata={}, int64_t timestamp=0)
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::DataLogValueEntryImpl< float >
wpi::mutex	m_mutex
std::optional< float >	m_lastValue
Protected Attributes inherited from wpi::log::DataLogEntry
DataLog *	m_log = nullptr
int	m_entry = 0

Detailed Description

Log float values.

Constructor & Destructor Documentation

FloatLogEntry() [1/3]

wpi::log::FloatLogEntry::FloatLogEntry ( )

default

FloatLogEntry() [2/3]

wpi::log::FloatLogEntry::FloatLogEntry ( DataLog & log, std::string_view name, int64_t timestamp = 0 )

inline

FloatLogEntry() [3/3]

wpi::log::FloatLogEntry::FloatLogEntry ( DataLog & log, std::string_view name, std::string_view metadata, int64_t timestamp = 0 )

inline

Member Function Documentation

Append()

void wpi::log::FloatLogEntry::Append ( float value, int64_t timestamp = 0 )

inline

Appends a record to the log.

Parameters

value	Value to record
timestamp	Time stamp (may be 0 to indicate now)

Update()

void wpi::log::FloatLogEntry::Update ( float value, int64_t timestamp = 0 )

inline

Updates the last value and appends a record to the log if it has changed.

Note

The last value is local to this class instance; using Update() with two instances pointing to the same underlying log entry name will likely result in unexpected results.

Parameters

value	Value to record
timestamp	Time stamp (may be 0 to indicate now)

Member Data Documentation

kDataType

std::string_view wpi::log::FloatLogEntry::kDataType = "float"

staticconstexpr

---

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

• wpi/DataLog.h