gadget2/reference/stockprinter_8h_source.html

 #ifndef stockprinter_h

 #define stockprinter_h


 #include "printer.h"

 #include "stockaggregator.h"


 class StockPrinter : public Printer {

 public:

   StockPrinter(CommentStream& infile, const TimeClass* const TimeInfo);

   virtual ~StockPrinter();

   virtual void setStock(StockPtrVector& stockvec, const AreaClass* const Area);

   virtual void Print(const TimeClass* const TimeInfo, int printtime);

 protected:

   IntMatrix areas;

   IntMatrix ages;

   CharPtrVector areaindex;

   CharPtrVector ageindex;

   CharPtrVector lenindex;

   CharPtrVector stocknames;

   LengthGroupDivision* LgrpDiv;

   StockAggregator* aggregator;

   const AgeBandMatrixPtrVector* alptr;

 };


 #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

CharPtrVector
This class implements a dynamic vector of char values.
Definition: charptrvector.h:8

CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40

IntMatrix
This class implements a dynamic vector of IntVector values.
Definition: intmatrix.h:10

LengthGroupDivision
This is the class used to store information about the length groups of the modelled stock population.
Definition: lengthgroup.h:10

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

StockPrinter
This is the class used to print information about one or more stocks.
Definition: stockprinter.h:11

StockPrinter::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: stockprinter.cc:137

StockPrinter::stocknames
CharPtrVector stocknames
This is the CharPtrVector of the names of the stocks to print.
Definition: stockprinter.h:59

StockPrinter::areaindex
CharPtrVector areaindex
This is the CharPtrVector of the names of the aggregated areas to print.
Definition: stockprinter.h:47

StockPrinter::alptr
const AgeBandMatrixPtrVector * alptr
This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the aggreg...
Definition: stockprinter.h:71

StockPrinter::ageindex
CharPtrVector ageindex
This is the CharPtrVector of the names of the aggregated ages to print.
Definition: stockprinter.h:51

StockPrinter::lenindex
CharPtrVector lenindex
This is the CharPtrVector of the names of the lengths to print.
Definition: stockprinter.h:55

StockPrinter::ages
IntMatrix ages
This is the IntMatrix used to store aggregated age information.
Definition: stockprinter.h:43

StockPrinter::LgrpDiv
LengthGroupDivision * LgrpDiv
This is the LengthGroupDivision of the stock.
Definition: stockprinter.h:63

StockPrinter::~StockPrinter
virtual ~StockPrinter()
This is the default StockPrinter destructor.
Definition: stockprinter.cc:249

StockPrinter::StockPrinter
StockPrinter(CommentStream &infile, const TimeClass *const TimeInfo)
This is the default StockPrinter constructor.
Definition: stockprinter.cc:16

StockPrinter::areas
IntMatrix areas
This is the IntMatrix used to store aggregated area information.
Definition: stockprinter.h:39

StockPrinter::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: stockprinter.cc:219

StockPrinter::aggregator
StockAggregator * aggregator
This is the StockAggregator used to collect information about the stocks.
Definition: stockprinter.h:67

StockPtrVector
This class implements a dynamic vector of Stock values.
Definition: stockptrvector.h:10

TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87

printer.h

stockaggregator.h