1 : |
agomez |
1 |
#ifndef predatoroveraggregator_h
|
2 : |
|
|
#define predatoroveraggregator_h
|
3 : |
|
|
|
4 : |
|
|
#include "agebandmatrix.h" |
5 : |
|
|
#include "intmatrix.h" |
6 : |
|
|
#include "predatorptrvector.h" |
7 : |
|
|
|
8 : |
|
|
/**
|
9 : |
|
|
* \class PredatorOverAggregator
|
10 : |
|
|
* \brief This is the class used to aggregate the calculated overconsumption by predators
|
11 : |
|
|
*/
|
12 : |
|
|
class PredatorOverAggregator {
|
13 : |
|
|
public:
|
14 : |
|
|
/**
|
15 : |
|
|
* \brief This is the PredatorOverAggregator constructor
|
16 : |
|
|
* \param predators is the PredatorPtrVector of the predators that will be aggregated
|
17 : |
|
|
* \param Areas is the IntMatrix of areas that the overconsumption can occur on
|
18 : |
|
|
* \param LgrpDiv is the LengthGroupDivision for the predators
|
19 : |
|
|
*/
|
20 : |
|
|
PredatorOverAggregator(const PredatorPtrVector& predators,
|
21 : |
|
|
const IntMatrix& Areas, const LengthGroupDivision* const LgrpDiv);
|
22 : |
|
|
/**
|
23 : |
|
|
* \brief This is the default PredatorOverAggregator destructor
|
24 : |
|
|
*/
|
25 : |
|
|
~PredatorOverAggregator() {};
|
26 : |
|
|
/**
|
27 : |
|
|
* \brief This will reset the predator overconsumption information
|
28 : |
|
|
*/
|
29 : |
|
|
void Reset();
|
30 : |
|
|
/**
|
31 : |
|
|
* \brief This will aggregate the predator overconsumption that has taken place
|
32 : |
|
|
*/
|
33 : |
|
|
void Sum();
|
34 : |
|
|
/**
|
35 : |
|
|
* \brief This will return the calculated overconsumption
|
36 : |
|
|
* \return total, the DoubleMatrix of overconsumption
|
37 : |
|
|
*/
|
38 : |
|
|
const DoubleMatrix& getSum() const { return total; };
|
39 : |
|
|
protected:
|
40 : |
|
|
/**
|
41 : |
|
|
* \brief This is the PredatorPtrVector of predators that will be aggregated
|
42 : |
|
|
*/
|
43 : |
|
|
PredatorPtrVector predators;
|
44 : |
|
|
/**
|
45 : |
|
|
* \brief This is the IntMatrix of length groups of the predators
|
46 : |
|
|
*/
|
47 : |
|
|
IntMatrix predConv;
|
48 : |
|
|
/**
|
49 : |
|
|
* \brief This is the IntMatrix used to store area information
|
50 : |
|
|
*/
|
51 : |
|
|
IntMatrix areas;
|
52 : |
|
|
/**
|
53 : |
|
|
* \brief This is the DoubleMatrix of the overconsumption that has taken place
|
54 : |
|
|
*/
|
55 : |
|
|
DoubleMatrix total;
|
56 : |
|
|
};
|
57 : |
|
|
|
58 : |
|
|
#endif
|