1 : |
agomez |
1 |
#ifndef stockstdprinter_h
|
2 : |
|
|
#define stockstdprinter_h
|
3 : |
|
|
|
4 : |
|
|
#include "printer.h" |
5 : |
|
|
#include "stockaggregator.h" |
6 : |
|
|
#include "stockpreyaggregator.h" |
7 : |
|
|
#include "popstatistics.h" |
8 : |
|
|
|
9 : |
|
|
/**
|
10 : |
|
|
* \class StockStdPrinter
|
11 : |
|
|
* \brief This is the class used to print 'standard' information about a stock
|
12 : |
|
|
*/
|
13 : |
|
|
class StockStdPrinter : public Printer {
|
14 : |
|
|
public:
|
15 : |
|
|
/**
|
16 : |
|
|
* \brief This is the default StockStdPrinter constructor
|
17 : |
|
|
* \param infile is the CommentStream to read the printer parameters from
|
18 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
19 : |
|
|
*/
|
20 : |
|
|
StockStdPrinter(CommentStream& infile, const TimeClass* const TimeInfo);
|
21 : |
|
|
/**
|
22 : |
|
|
* \brief This is the default StockStdPrinter destructor
|
23 : |
|
|
*/
|
24 : |
|
|
virtual ~StockStdPrinter();
|
25 : |
|
|
/**
|
26 : |
|
|
* \brief This will select the stocks required for the printer class to print the requested information
|
27 : |
|
|
* \param stockvec is the StockPtrVector of all the available stocks
|
28 : |
|
|
* \param Area is the AreaClass for the current model
|
29 : |
|
|
*/
|
30 : |
|
|
virtual void setStock(StockPtrVector& stockvec, const AreaClass* const Area);
|
31 : |
|
|
/**
|
32 : |
|
|
* \brief This will print the requested information for the printer class to the ofstream specified
|
33 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
34 : |
|
|
* \param printtime is the flag to denote when the printing is taking place
|
35 : |
|
|
*/
|
36 : |
|
|
virtual void Print(const TimeClass* const TimeInfo, int printtime);
|
37 : |
|
|
protected:
|
38 : |
|
|
/**
|
39 : |
|
|
* \brief This is the name of the stock
|
40 : |
|
|
*/
|
41 : |
|
|
char* stockname;
|
42 : |
|
|
/**
|
43 : |
|
|
* \brief This is the LengthGroupDivision of the stock
|
44 : |
|
|
*/
|
45 : |
|
|
LengthGroupDivision* LgrpDiv;
|
46 : |
|
|
/**
|
47 : |
|
|
* \brief This is the IntVector used to store aggregated area information
|
48 : |
|
|
*/
|
49 : |
|
|
IntVector outerareas;
|
50 : |
|
|
/**
|
51 : |
|
|
* \brief This is the flag to denote whether the stock is a prey or not
|
52 : |
|
|
*/
|
53 : |
|
|
int isaprey;
|
54 : |
|
|
/**
|
55 : |
|
|
* \brief This is the minimum age of the stock
|
56 : |
|
|
*/
|
57 : |
|
|
int minage;
|
58 : |
|
|
/**
|
59 : |
|
|
* \brief This is the scaling factor used to scale the size of the stock
|
60 : |
|
|
*/
|
61 : |
|
|
double scale;
|
62 : |
|
|
/**
|
63 : |
|
|
* \brief This is the StockAggregator used to collect information about the stock
|
64 : |
|
|
*/
|
65 : |
|
|
StockAggregator* saggregator;
|
66 : |
|
|
/**
|
67 : |
|
|
* \brief This is the StockPreyAggregator used to collect information about the stock prey
|
68 : |
|
|
*/
|
69 : |
|
|
StockPreyAggregator* paggregator;
|
70 : |
|
|
/**
|
71 : |
|
|
* \brief This is the PopStatistics used to calculate the statistics of the population
|
72 : |
|
|
*/
|
73 : |
|
|
PopStatistics ps;
|
74 : |
|
|
/**
|
75 : |
|
|
* \brief This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the stock aggregatation function
|
76 : |
|
|
*/
|
77 : |
|
|
const AgeBandMatrixPtrVector* salptr;
|
78 : |
|
|
/**
|
79 : |
|
|
* \brief This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the prey aggregatation function
|
80 : |
|
|
*/
|
81 : |
|
|
const AgeBandMatrixPtrVector* palptr;
|
82 : |
|
|
};
|
83 : |
|
|
|
84 : |
|
|
#endif
|