[mareframe] Annotation of /trunk/gadget/lengthprey.h
Annotation of /trunk/gadget/lengthprey.h
Parent Directory
| Revision Log
Revision 1 -
(view)
(download)
1 : |
agomez |
1 |
#ifndef lengthprey_h
|
2 : |
|
|
#define lengthprey_h
|
3 : |
|
|
|
4 : |
|
|
#include "prey.h" |
5 : |
|
|
|
6 : |
|
|
/**
|
7 : |
|
|
* \class LengthPrey
|
8 : |
|
|
* \brief This is the class used to model a simple length based prey
|
9 : |
|
|
* \note This class is only used to model non-dynamic prey (ie the prey from OtherFood)
|
10 : |
|
|
*/
|
11 : |
|
|
class LengthPrey : public Prey {
|
12 : |
|
|
public:
|
13 : |
|
|
/**
|
14 : |
|
|
* \brief This is the LengthPrey constructor
|
15 : |
|
|
* \param infile is the CommentStream to read the Prey data from
|
16 : |
|
|
* \param givenname is the name of the prey
|
17 : |
|
|
* \param areas is the IntVector of areas that the prey lives on
|
18 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
19 : |
|
|
* \param keeper is the Keeper for the current model
|
20 : |
|
|
*/
|
21 : |
|
|
LengthPrey(CommentStream& infile, const char* givenname,
|
22 : |
|
|
const IntVector& areas, const TimeClass* const TimeInfo, Keeper* const keeper);
|
23 : |
|
|
/**
|
24 : |
|
|
* \brief This is the default LengthPrey destructor
|
25 : |
|
|
*/
|
26 : |
|
|
~LengthPrey() {};
|
27 : |
|
|
/**
|
28 : |
|
|
* \brief This will calculate the amount of prey that is consumed for a given area and timestep
|
29 : |
|
|
* \param NumberInArea is the PopInfoVector giving the amount of prey in the area
|
30 : |
|
|
* \param area is the area that the prey consumption is being calculated on
|
31 : |
|
|
*/
|
32 : |
|
|
virtual void Sum(const PopInfoVector& NumberInArea, int area);
|
33 : |
|
|
};
|
34 : |
|
|
|
35 : |
|
|
#endif
|
|