1 : |
agomez |
1 |
#ifndef lengthpredator_h
|
2 : |
|
|
#define lengthpredator_h
|
3 : |
|
|
|
4 : |
|
|
#include "poppredator.h" |
5 : |
|
|
|
6 : |
|
|
/**
|
7 : |
|
|
* \class LengthPredator
|
8 : |
|
|
* \brief This is the class used to model the predation of stocks by a fleet
|
9 : |
|
|
*/
|
10 : |
|
|
class LengthPredator : public PopPredator {
|
11 : |
|
|
public:
|
12 : |
|
|
/**
|
13 : |
|
|
* \brief This is the LengthPredator constructor
|
14 : |
|
|
* \param givenname is the name of the predator
|
15 : |
|
|
* \param Areas is the IntVector of areas that the predator lives on
|
16 : |
|
|
* \param keeper is the Keeper for the current model
|
17 : |
|
|
* \param multscaler is the Formula that can be used to scale the biomass consumed
|
18 : |
|
|
*/
|
19 : |
|
|
LengthPredator(const char* givenname, const IntVector& Areas,
|
20 : |
|
|
Keeper* const keeper, Formula multscaler);
|
21 : |
|
|
/**
|
22 : |
|
|
* \brief This is the default LengthPredator destructor
|
23 : |
|
|
*/
|
24 : |
|
|
virtual ~LengthPredator() {};
|
25 : |
|
|
/**
|
26 : |
|
|
* \brief This will calculate the amount of prey that is consumed by the predator
|
27 : |
|
|
* \param NumberInArea is the PopInfoVector giving the amount of prey in the area
|
28 : |
|
|
* \param area is the area that the prey consumption is being calculated on
|
29 : |
|
|
*/
|
30 : |
|
|
virtual void Sum(const PopInfoVector& NumberInArea, int area);
|
31 : |
|
|
/**
|
32 : |
|
|
* \brief This will return the multiplicative value used scale the catch
|
33 : |
|
|
* \return multi
|
34 : |
|
|
*/
|
35 : |
|
|
double getMultScaler() const { return multi; };
|
36 : |
|
|
/**
|
37 : |
|
|
* \brief This function will reset the predation information
|
38 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
39 : |
|
|
*/
|
40 : |
|
|
virtual void Reset(const TimeClass* const TimeInfo);
|
41 : |
|
|
protected:
|
42 : |
|
|
/**
|
43 : |
|
|
* \brief This is the multiplicative constant that can be used to scale the biomass consumed
|
44 : |
|
|
*/
|
45 : |
|
|
Formula multi;
|
46 : |
|
|
};
|
47 : |
|
|
|
48 : |
|
|
#endif
|