Gadget
stockstdprinter.h
Go to the documentation of this file.
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 
13 class StockStdPrinter : public Printer {
14 public:
20  StockStdPrinter(CommentStream& infile, const TimeClass* const TimeInfo);
24  virtual ~StockStdPrinter();
30  virtual void setStock(StockPtrVector& stockvec, const AreaClass* const Area);
36  virtual void Print(const TimeClass* const TimeInfo, int printtime);
37 protected:
41  char* stockname;
45  LengthGroupDivision* LgrpDiv;
49  IntVector outerareas;
53  int isaprey;
57  int minage;
61  double scale;
65  StockAggregator* saggregator;
69  StockPreyAggregator* paggregator;
73  PopStatistics ps;
77  const AgeBandMatrixPtrVector* salptr;
81  const AgeBandMatrixPtrVector* palptr;
82 };
83 
84 #endif
AgeBandMatrixPtrVector
This class implements a dynamic vector of AgeBandMatrix values.
Definition: agebandmatrixptrvector.h:12
AreaClass
This is the class used to store information about the areas used for the current model.
Definition: areatime.h:18
CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40
IntVector
This class implements a dynamic vector of int values.
Definition: intvector.h:11
LengthGroupDivision
This is the class used to store information about the length groups of the modelled stock population.
Definition: lengthgroup.h:10
PopStatistics
This is the class used to calculate some standard statistics about a given population.
Definition: popstatistics.h:13
Printer
This is the base class used to print the modelled population during a model simulation.
Definition: printer.h:26
StockAggregator
This is the class used to aggregate stock information.
Definition: stockaggregator.h:14
StockPreyAggregator
This is the class used to aggregate stock prey information.
Definition: stockpreyaggregator.h:14
StockPtrVector
This class implements a dynamic vector of Stock values.
Definition: stockptrvector.h:10
StockStdPrinter
This is the class used to print 'standard' information about a stock.
Definition: stockstdprinter.h:13
StockStdPrinter::palptr
const AgeBandMatrixPtrVector * palptr
This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the prey a...
Definition: stockstdprinter.h:81
StockStdPrinter::ps
PopStatistics ps
This is the PopStatistics used to calculate the statistics of the population.
Definition: stockstdprinter.h:73
StockStdPrinter::~StockStdPrinter
virtual ~StockStdPrinter()
This is the default StockStdPrinter destructor.
Definition: stockstdprinter.cc:115
StockStdPrinter::setStock
virtual void setStock(StockPtrVector &stockvec, const AreaClass *const Area)
This will select the stocks required for the printer class to print the requested information.
Definition: stockstdprinter.cc:125
StockStdPrinter::minage
int minage
This is the minimum age of the stock.
Definition: stockstdprinter.h:57
StockStdPrinter::stockname
char * stockname
This is the name of the stock.
Definition: stockstdprinter.h:41
StockStdPrinter::salptr
const AgeBandMatrixPtrVector * salptr
This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the stock ...
Definition: stockstdprinter.h:77
StockStdPrinter::saggregator
StockAggregator * saggregator
This is the StockAggregator used to collect information about the stock.
Definition: stockstdprinter.h:65
StockStdPrinter::StockStdPrinter
StockStdPrinter(CommentStream &infile, const TimeClass *const TimeInfo)
This is the default StockStdPrinter constructor.
Definition: stockstdprinter.cc:17
StockStdPrinter::LgrpDiv
LengthGroupDivision * LgrpDiv
This is the LengthGroupDivision of the stock.
Definition: stockstdprinter.h:45
StockStdPrinter::Print
virtual void Print(const TimeClass *const TimeInfo, int printtime)
This will print the requested information for the printer class to the ofstream specified.
Definition: stockstdprinter.cc:178
StockStdPrinter::outerareas
IntVector outerareas
This is the IntVector used to store aggregated area information.
Definition: stockstdprinter.h:49
StockStdPrinter::paggregator
StockPreyAggregator * paggregator
This is the StockPreyAggregator used to collect information about the stock prey.
Definition: stockstdprinter.h:69
StockStdPrinter::scale
double scale
This is the scaling factor used to scale the size of the stock.
Definition: stockstdprinter.h:61
StockStdPrinter::isaprey
int isaprey
This is the flag to denote whether the stock is a prey or not.
Definition: stockstdprinter.h:53
TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87
Generated by doxygen 1.9.1