DataLogger Class Reference

DataLogger class. More...

#include <data_logger.hpp>

Public Member Functions
	DataLogger (const std::string &log_directory, const std::string &file_name)
	DataLogger constructor. More...
	DataLogger (const std::string &log_directory, const std::string &file_name, double logging_rate)
	DataLogger constructor. More...
void	Log (const std::string &message)
	Log message. More...
void	RateLimitedLog (const std::string &message, double time)
	Log rate-limited messages. More...
void	DefineHeader (const std::string &header)
	Function to set the output file header. More...
void	EnableLogging ()
	Function to enable logging.
void	SetOutputDirectory (const std::string &log_directory)
	Output directory setter. More...
void	SetOutputFileName (const std::string &file_name)
	Output file name setter. More...
void	SetLogRate (double rate)
	Data logging rate setter. More...

Detailed Description

DataLogger class.

Constructor & Destructor Documentation

DataLogger() [1/2]

DataLogger::DataLogger	(	const std::string &	log_directory,
		const std::string &	file_name
	)

DataLogger constructor.

Parameters

log_directory	Output directory for creating data log file
file_name	Name of data log file

DataLogger() [2/2]

DataLogger::DataLogger	(	const std::string &	log_directory,
		const std::string &	file_name,
		double	logging_rate
	)

DataLogger constructor.

Parameters

log_directory	Output directory for creating data log file
file_name	Name of data log file
logging_rate	Logging rate

Member Function Documentation

DefineHeader()

void DataLogger::DefineHeader

(

const std::string &

header

)

Function to set the output file header.

Parameters

header

Header string for output file

Log()

void DataLogger::Log

(

const std::string &

message

)

Log message.

Parameters

message

Message contents of log

RateLimitedLog()

void DataLogger::RateLimitedLog	(	const std::string &	message,
		double	time
	)

Log rate-limited messages.

Parameters

message	Message contents of log
time	Message log time for rate-limited logging

SetLogRate()

void DataLogger::SetLogRate

(

double

rate

)

Data logging rate setter.

Parameters

rate	Data logging rate

SetOutputDirectory()

void DataLogger::SetOutputDirectory

(

const std::string &

log_directory

)

Output directory setter.

Parameters

log_directory

Output directory string

SetOutputFileName()

void DataLogger::SetOutputFileName

(

const std::string &

file_name

)

Output file name setter.

Parameters

file_name

Output file name

---

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

• src/infrastructure/data_logger.hpp
• src/infrastructure/data_logger.cpp