Gadget
stockaggregator.h
Go to the documentation of this file.
1 #ifndef stockaggregator_h
2 #define stockaggregator_h
3 
4 #include "agebandmatrix.h"
5 #include "agebandmatrixptrvector.h"
6 #include "stockptrvector.h"
7 #include "conversionindexptrvector.h"
8 #include "intmatrix.h"
9 
14 class StockAggregator {
15 public:
23  StockAggregator(const StockPtrVector& Stocks, const LengthGroupDivision* const LgrpDiv,
24  const IntMatrix& Areas, const IntMatrix& Ages);
28  ~StockAggregator();
32  void Reset();
36  void Sum();
41  const AgeBandMatrixPtrVector& getSum() const { return total; };
46  void Print(ofstream &outfile) const;
47 protected:
51  StockPtrVector stocks;
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
StockAggregator
This is the class used to aggregate stock information.
Definition: stockaggregator.h:14
StockAggregator::getSum
const AgeBandMatrixPtrVector & getSum() const
This will return the AgeBandMatrixPtrVector containing the aggregated stock information.
Definition: stockaggregator.h:41
StockAggregator::alptr
const AgeBandMatrix * alptr
This is the AgeBandMatrix used to temporarily store information when aggregating the stocks.
Definition: stockaggregator.h:71
StockAggregator::Print
void Print(ofstream &outfile) const
This will print the aggregator information to the ofstream specified.
Definition: stockaggregator.cc:34
StockAggregator::Reset
void Reset()
This function will reset the stock data.
Definition: stockaggregator.cc:46
StockAggregator::areas
IntMatrix areas
This is the IntMatrix used to store area information.
Definition: stockaggregator.h:59
StockAggregator::~StockAggregator
~StockAggregator()
This is the default StockAggregator destructor.
Definition: stockaggregator.cc:28
StockAggregator::stocks
StockPtrVector stocks
This is the StockPtrVector of the stocks that will be aggregated.
Definition: stockaggregator.h:51
StockAggregator::Sum
void Sum()
This function will aggregate the stock data.
Definition: stockaggregator.cc:52
StockAggregator::StockAggregator
StockAggregator(const StockPtrVector &Stocks, const LengthGroupDivision *const LgrpDiv, const IntMatrix &Areas, const IntMatrix &Ages)
This is the StockAggregator constructor.
Definition: stockaggregator.cc:9
StockAggregator::ages
IntMatrix ages
This is the IntMatrix used to store age information.
Definition: stockaggregator.h:63
StockAggregator::total
AgeBandMatrixPtrVector total
This is the AgeBandMatrixPtrVector used to store the aggregated stock information.
Definition: stockaggregator.h:67
StockAggregator::CI
ConversionIndexPtrVector CI
This is the ConversionIndexPtrVector used to convert the length groups of the stocks to be aggregated...
Definition: stockaggregator.h:55
StockPtrVector
This class implements a dynamic vector of Stock values.
Definition: stockptrvector.h:10
Generated by doxygen 1.9.1