LBIBCell
 All Classes Functions Variables Friends Pages
LbmLib::reportHandler::ReportHandler Class Reference

the report handler which stores the reporters More...

#include <ReportHandler.hpp>

Public Member Functions

 ReportHandler (unsigned int reportStep=1)
 ReportHandler The constructor for the report Handler. More...
 
void registerReporter (std::unique_ptr< AbstractReportFunctor > reporter)
 registerReporter Register a report Functor. This method takes ownership of the unique_ptr passed More...
 
void writeReport (unsigned int time) const
 writeReport Writes the report if the time step fits to the reportStep More...
 
void writeCrashReport (unsigned int time) const
 writeCrashReport Dumps the reporters when crashed. More...
 

Detailed Description

the report handler which stores the reporters

Definition at line 34 of file ReportHandler.hpp.

Constructor & Destructor Documentation

LbmLib::reportHandler::ReportHandler::ReportHandler ( unsigned int  reportStep = 1)
inlineexplicit

ReportHandler The constructor for the report Handler.

Parameters
reportStepThe step at which a report is generated

Definition at line 40 of file ReportHandler.hpp.

Member Function Documentation

void LbmLib::reportHandler::ReportHandler::registerReporter ( std::unique_ptr< AbstractReportFunctor reporter)

registerReporter Register a report Functor. This method takes ownership of the unique_ptr passed

Parameters
reporterThe reporter added to the report Handler

Definition at line 31 of file ReportHandler.cpp.

void LbmLib::reportHandler::ReportHandler::writeCrashReport ( unsigned int  time) const

writeCrashReport Dumps the reporters when crashed.

Parameters
timeThe current time

Definition at line 48 of file ReportHandler.cpp.

void LbmLib::reportHandler::ReportHandler::writeReport ( unsigned int  time) const

writeReport Writes the report if the time step fits to the reportStep

Parameters
timeThe current time

Definition at line 40 of file ReportHandler.cpp.


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