Gadget
stockpreyaggregator.h
Go to the documentation of this file.
1 #ifndef stockpreyaggregator_h
2 #define stockpreyaggregator_h
3 
4 #include "agebandmatrix.h"
5 #include "agebandmatrixptrvector.h"
6 #include "preyptrvector.h"
7 #include "conversionindexptrvector.h"
8 #include "intmatrix.h"
9 
14 class StockPreyAggregator {
15 public:
23  StockPreyAggregator(const PreyPtrVector& Preys, const LengthGroupDivision* const LgrpDiv,
24  const IntMatrix& Areas, const IntMatrix& Ages);
28  ~StockPreyAggregator();
32  void Reset();
36  void Sum();
41  const AgeBandMatrixPtrVector& getSum() const { return total; };
46  void Print(ofstream &outfile) const;
47 protected:
51  PreyPtrVector preys;
55  ConversionIndexPtrVector CI;
59  IntMatrix areas;
63  IntMatrix ages;
67  AgeBandMatrixPtrVector total;
71  const AgeBandMatrix* alptr;
72 };
73 
74 #endif
AgeBandMatrixPtrVector
This class implements a dynamic vector of AgeBandMatrix values.
Definition: agebandmatrixptrvector.h:12
AgeBandMatrix
This class implements a vector of PopInfoIndexVector values, indexed from minage not 0.
Definition: agebandmatrix.h:15
ConversionIndexPtrVector
This class implements a dynamic vector of ConversionIndex values.
Definition: conversionindexptrvector.h:10
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
PreyPtrVector
This class implements a dynamic vector of Prey values.
Definition: preyptrvector.h:10
StockPreyAggregator
This is the class used to aggregate stock prey information.
Definition: stockpreyaggregator.h:14
StockPreyAggregator::alptr
const AgeBandMatrix * alptr
This is the AgeBandMatrix used to temporarily store information when aggregating the preys.
Definition: stockpreyaggregator.h:71
StockPreyAggregator::CI
ConversionIndexPtrVector CI
This is the ConversionIndexPtrVector used to convert the length groups of the preys to be aggregated.
Definition: stockpreyaggregator.h:55
StockPreyAggregator::Reset
void Reset()
This function will reset the stock prey data.
Definition: stockpreyaggregator.cc:50
StockPreyAggregator::getSum
const AgeBandMatrixPtrVector & getSum() const
This will return the AgeBandMatrixPtrVector containing the aggregated stock prey information.
Definition: stockpreyaggregator.h:41
StockPreyAggregator::ages
IntMatrix ages
This is the IntMatrix used to store age information.
Definition: stockpreyaggregator.h:63
StockPreyAggregator::preys
PreyPtrVector preys
This is the PreyPtrVector of the preys that will be aggregated.
Definition: stockpreyaggregator.h:51
StockPreyAggregator::Sum
void Sum()
This function will aggregate the stock prey data.
Definition: stockpreyaggregator.cc:56
StockPreyAggregator::Print
void Print(ofstream &outfile) const
This will print the aggregator information to the ofstream specified.
Definition: stockpreyaggregator.cc:38
StockPreyAggregator::areas
IntMatrix areas
This is the IntMatrix used to store area information.
Definition: stockpreyaggregator.h:59
StockPreyAggregator::StockPreyAggregator
StockPreyAggregator(const PreyPtrVector &Preys, const LengthGroupDivision *const LgrpDiv, const IntMatrix &Areas, const IntMatrix &Ages)
This is the StockPreyAggregator constructor.
Definition: stockpreyaggregator.cc:9
StockPreyAggregator::~StockPreyAggregator
~StockPreyAggregator()
This is the default StockPreyAggregator destructor.
Definition: stockpreyaggregator.cc:32
StockPreyAggregator::total
AgeBandMatrixPtrVector total
This is the AgeBandMatrixPtrVector used to store the aggregated stock prey information.
Definition: stockpreyaggregator.h:67
Generated by doxygen 1.9.1