wpi::log::StringArrayLogEntry Class Reference

Log array of string values. More...

#include <wpi/datalog/DataLog.hpp>

Inheritance diagram for wpi::log::StringArrayLogEntry:

Public Member Functions
	StringArrayLogEntry ()=default
	StringArrayLogEntry (DataLog &log, std::string_view name, int64_t timestamp=0)
	StringArrayLogEntry (DataLog &log, std::string_view name, std::string_view metadata, int64_t timestamp=0)
void	Append (std::span< const std::string > arr, int64_t timestamp=0)
	Appends a record to the log.
void	Append (std::span< const std::string_view > arr, int64_t timestamp=0)
	Appends a record to the log.
void	Append (std::initializer_list< std::string_view > arr, int64_t timestamp=0)
	Appends a record to the log.
void	Update (std::span< const std::string > arr, int64_t timestamp=0)
	Updates the last value and appends a record to the log if it has changed.
void	Update (std::span< const std::string_view > arr, int64_t timestamp=0)
	Updates the last value and appends a record to the log if it has changed.
void	Update (std::initializer_list< std::string_view > arr, 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< std::vector< std::string > >
DataLogValueEntryImpl &	operator= (DataLogValueEntryImpl &&rhs)
bool	HasLastValue () const
	Gets whether there is a last value.
std::optional< std::vector< std::string > >	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 const char *	kDataType = "string[]"

Additional Inherited Members
Protected Member Functions inherited from wpi::log::DataLogValueEntryImpl< std::vector< std::string > >
	DataLogValueEntryImpl ()=default
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< std::vector< std::string > >
wpi::util::mutex	m_mutex
std::optional< std::vector< std::string > >	m_lastValue
Protected Attributes inherited from wpi::log::DataLogEntry
DataLog *	m_log = nullptr
int	m_entry = 0

Detailed Description

Log array of string values.

Constructor & Destructor Documentation

StringArrayLogEntry() [1/3]

wpi::log::StringArrayLogEntry::StringArrayLogEntry ( )

default

StringArrayLogEntry() [2/3]

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

inline

StringArrayLogEntry() [3/3]

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

inline

Member Function Documentation

Append() [1/3]

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

inline

Appends a record to the log.

Parameters

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Append() [2/3]

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

inline

Appends a record to the log.

Parameters

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Append() [3/3]

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

inline

Appends a record to the log.

Parameters

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Update() [1/3]

void wpi::log::StringArrayLogEntry::Update ( std::initializer_list< std::string_view > arr, 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

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Update() [2/3]

void wpi::log::StringArrayLogEntry::Update	(	std::span< const std::string >	arr,
		int64_t	timestamp = 0 )

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

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Update() [3/3]

void wpi::log::StringArrayLogEntry::Update	(	std::span< const std::string_view >	arr,
		int64_t	timestamp = 0 )

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

arr	Values to record
timestamp	Time stamp (may be 0 to indicate now)

Member Data Documentation

kDataType

const char* wpi::log::StringArrayLogEntry::kDataType = "string[]"

staticconstexpr

---

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

• wpi/datalog/DataLog.hpp