[mareframe] Annotation of /trunk/gadget/summaryprinter.h
Annotation of /trunk/gadget/summaryprinter.h
Parent Directory
| Revision Log
Revision 1 -
(view)
(download)
1 : |
agomez |
1 |
#ifndef summaryprinter_h
|
2 : |
|
|
#define summaryprinter_h
|
3 : |
|
|
|
4 : |
|
|
#include "printer.h" |
5 : |
|
|
|
6 : |
|
|
/**
|
7 : |
|
|
* \class SummaryPrinter
|
8 : |
|
|
* \brief This is the class used to print likelihood summary information
|
9 : |
|
|
*/
|
10 : |
|
|
class SummaryPrinter : public Printer {
|
11 : |
|
|
public:
|
12 : |
|
|
/**
|
13 : |
|
|
* \brief This is the default SummaryPrinter constructor
|
14 : |
|
|
* \param infile is the CommentStream to read the printer parameters from
|
15 : |
|
|
*/
|
16 : |
|
|
SummaryPrinter(CommentStream& infile);
|
17 : |
|
|
/**
|
18 : |
|
|
* \brief This is the default SummaryPrinter destructor
|
19 : |
|
|
*/
|
20 : |
|
|
virtual ~SummaryPrinter();
|
21 : |
|
|
/**
|
22 : |
|
|
* \brief This will select the likelihood components required for the printer class to print the requested information
|
23 : |
|
|
* \param likevec is the LikelihoodPtrVector of all the available likelihood components
|
24 : |
|
|
*/
|
25 : |
|
|
virtual void setLikelihood(LikelihoodPtrVector& likevec);
|
26 : |
|
|
/**
|
27 : |
|
|
* \brief This will print the requested information for the printer class to the ofstream specified
|
28 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
29 : |
|
|
* \param printtime is the flag to denote when the printing is taking place
|
30 : |
|
|
*/
|
31 : |
|
|
virtual void Print(const TimeClass* const TimeInfo, int printtime);
|
32 : |
|
|
protected:
|
33 : |
|
|
/**
|
34 : |
|
|
* \brief This is the LikelihoodPtrVector that is storing the likelihood component to print
|
35 : |
|
|
*/
|
36 : |
|
|
LikelihoodPtrVector like;
|
37 : |
|
|
};
|
38 : |
|
|
|
39 : |
|
|
#endif
|
|