AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
autopas::LiveInfoLogger Class Reference

Helper to log the collected LiveInfo data during tuning to a csv file for easier analysis. More...

#include <LiveInfoLogger.h>

Public Member Functions

 LiveInfoLogger (const std::string &outputSuffix="")
 Constructor initializes the logger and sets the output file name.
 
 ~LiveInfoLogger ()
 Destructor drops the logger from the spd registry.
 
void logLiveInfo (const LiveInfo &liveInfo, size_t iteration)
 Log the given arguments and the internal buffer to the csv file.
 

Detailed Description

Helper to log the collected LiveInfo data during tuning to a csv file for easier analysis.

It uses an asynchronous spd logger to write a csv file named "AutoPas_liveInfoLogger_<dateStamp>.csv".

By default logging the data is disabled. It can be enabled by setting the cmake variable AUTOPAS_LOG_LIVEINFO to ON.

Constructor & Destructor Documentation

◆ LiveInfoLogger()

autopas::LiveInfoLogger::LiveInfoLogger ( const std::string &  outputSuffix = "")
explicit

Constructor initializes the logger and sets the output file name.

Parameters
outputSuffixSuffix for all output files produced by this class.

Member Function Documentation

◆ logLiveInfo()

void autopas::LiveInfoLogger::logLiveInfo ( const LiveInfo liveInfo,
size_t  iteration 
)

Log the given arguments and the internal buffer to the csv file.

Parameters
liveInfoThe liveInfo Struct to log.
iterationThe iteration number.

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