| 1 : |
agomez |
1 |
#ifndef stockprinter_h
|
| 2 : |
|
|
#define stockprinter_h
|
| 3 : |
|
|
|
| 4 : |
|
|
#include "printer.h" |
| 5 : |
|
|
#include "stockaggregator.h" |
| 6 : |
|
|
|
| 7 : |
|
|
/**
|
| 8 : |
|
|
* \class StockPrinter
|
| 9 : |
|
|
* \brief This is the class used to print information about one or more stocks
|
| 10 : |
|
|
*/
|
| 11 : |
|
|
class StockPrinter : public Printer {
|
| 12 : |
|
|
public:
|
| 13 : |
|
|
/**
|
| 14 : |
|
|
* \brief This is the default StockPrinter constructor
|
| 15 : |
|
|
* \param infile is the CommentStream to read the printer parameters from
|
| 16 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
| 17 : |
|
|
*/
|
| 18 : |
|
|
StockPrinter(CommentStream& infile, const TimeClass* const TimeInfo);
|
| 19 : |
|
|
/**
|
| 20 : |
|
|
* \brief This is the default StockPrinter destructor
|
| 21 : |
|
|
*/
|
| 22 : |
|
|
virtual ~StockPrinter();
|
| 23 : |
|
|
/**
|
| 24 : |
|
|
* \brief This will select the stocks required for the printer class to print the requested information
|
| 25 : |
|
|
* \param stockvec is the StockPtrVector of all the available stocks
|
| 26 : |
|
|
* \param Area is the AreaClass for the current model
|
| 27 : |
|
|
*/
|
| 28 : |
|
|
virtual void setStock(StockPtrVector& stockvec, const AreaClass* const Area);
|
| 29 : |
|
|
/**
|
| 30 : |
|
|
* \brief This will print the requested information for the printer class to the ofstream specified
|
| 31 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
| 32 : |
|
|
* \param printtime is the flag to denote when the printing is taking place
|
| 33 : |
|
|
*/
|
| 34 : |
|
|
virtual void Print(const TimeClass* const TimeInfo, int printtime);
|
| 35 : |
|
|
protected:
|
| 36 : |
|
|
/**
|
| 37 : |
|
|
* \brief This is the IntMatrix used to store aggregated area information
|
| 38 : |
|
|
*/
|
| 39 : |
|
|
IntMatrix areas;
|
| 40 : |
|
|
/**
|
| 41 : |
|
|
* \brief This is the IntMatrix used to store aggregated age information
|
| 42 : |
|
|
*/
|
| 43 : |
|
|
IntMatrix ages;
|
| 44 : |
|
|
/**
|
| 45 : |
|
|
* \brief This is the CharPtrVector of the names of the aggregated areas to print
|
| 46 : |
|
|
*/
|
| 47 : |
|
|
CharPtrVector areaindex;
|
| 48 : |
|
|
/**
|
| 49 : |
|
|
* \brief This is the CharPtrVector of the names of the aggregated ages to print
|
| 50 : |
|
|
*/
|
| 51 : |
|
|
CharPtrVector ageindex;
|
| 52 : |
|
|
/**
|
| 53 : |
|
|
* \brief This is the CharPtrVector of the names of the lengths to print
|
| 54 : |
|
|
*/
|
| 55 : |
|
|
CharPtrVector lenindex;
|
| 56 : |
|
|
/**
|
| 57 : |
|
|
* \brief This is the CharPtrVector of the names of the stocks to print
|
| 58 : |
|
|
*/
|
| 59 : |
|
|
CharPtrVector stocknames;
|
| 60 : |
|
|
/**
|
| 61 : |
|
|
* \brief This is the LengthGroupDivision of the stock
|
| 62 : |
|
|
*/
|
| 63 : |
|
|
LengthGroupDivision* LgrpDiv;
|
| 64 : |
|
|
/**
|
| 65 : |
|
|
* \brief This is the StockAggregator used to collect information about the stocks
|
| 66 : |
|
|
*/
|
| 67 : |
|
|
StockAggregator* aggregator;
|
| 68 : |
|
|
/**
|
| 69 : |
|
|
* \brief This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the aggregatation function
|
| 70 : |
|
|
*/
|
| 71 : |
|
|
const AgeBandMatrixPtrVector* alptr;
|
| 72 : |
|
|
};
|
| 73 : |
|
|
|
| 74 : |
|
|
#endif
|
Parent Directory
Revision Log