LBIBCell
 All Classes Functions Variables Friends Pages
ReportHandler.hpp
1 /* Copyright (c) 2013 David Sichau <mail"at"sichau"dot"eu>
2  * 2013-2015 Simon Tanaka <tanakas"at"gmx"dot"ch>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 #ifndef REPORTHANDLER_HPP
23 #define REPORTHANDLER_HPP
24 
25 #include <LbmLib/include/reportHandler/AbstractReportFunctor.hpp>
26 #include <vector>
27 #include <memory>
28 
29 namespace LbmLib {
30 namespace reportHandler {
35  public:
40  explicit ReportHandler(unsigned int reportStep =
41  1) : reportStep_(reportStep) {}
42 
47  void registerReporter(std::unique_ptr<AbstractReportFunctor> reporter);
48 
53  void writeReport(unsigned int time) const;
54 
59  void writeCrashReport(unsigned int time) const;
60 
61  private:
65  std::vector<std::unique_ptr<AbstractReportFunctor> > reporters_;
69  const unsigned int reportStep_;
70 };
71 }
72 } // end namespace
73 
74 #endif // REPORTHANDLER_HPP
void registerReporter(std::unique_ptr< AbstractReportFunctor > reporter)
registerReporter Register a report Functor. This method takes ownership of the unique_ptr passed ...
ReportHandler(unsigned int reportStep=1)
ReportHandler The constructor for the report Handler.
void writeCrashReport(unsigned int time) const
writeCrashReport Dumps the reporters when crashed.
void writeReport(unsigned int time) const
writeReport Writes the report if the time step fits to the reportStep
the report handler which stores the reporters