Annotation of /trunk/gadget/linearpredator.h

Parent Directory | Revision Log

---

Revision 1 - (view) (download)

1 :	agomez	1	#ifndef linearpredator_h
2 :			#define linearpredator_h
3 :
4 :			#include "lengthpredator.h"
5 :
6 :			/**
7 :			* \class LinearPredator
8 :			* \brief This is the class used to model the predation of stocks by a fleet that will catch a proportion of the available biomass
9 :			*/
10 :			class LinearPredator : public LengthPredator {
11 :			public:
12 :			/**
13 :			* \brief This is the LinearPredator constructor
14 :			* \param infile is the CommentStream to read the predation parameters from
15 :			* \param givenname is the name of the predator
16 :			* \param Areas is the IntVector of areas that the predator lives on
17 :			* \param TimeInfo is the TimeClass for the current model
18 :			* \param keeper is the Keeper for the current model
19 :			* \param multscaler is the Formula that can be used to scale the biomass consumed
20 :			*/
21 :			LinearPredator(CommentStream& infile, const char* givenname, const IntVector& Areas,
22 :			const TimeClass* const TimeInfo, Keeper* const keeper, Formula multscaler);
23 :			/**
24 :			* \brief This is the default LinearPredator destructor
25 :			*/
26 :			virtual ~LinearPredator() {};
27 :			/**
28 :			* \brief This will calculate the amount the predator consumes on a given area
29 :			* \param area is the area that the prey consumption is being calculated on
30 :			* \param Area is the AreaClass for the current model
31 :			* \param TimeInfo is the TimeClass for the current model
32 :			*/
33 :			virtual void Eat(int area, const AreaClass* const Area, const TimeClass* const TimeInfo);
34 :			/**
35 :			* \brief This will adjust the amount the predator consumes on a given area, to take oversconsumption into consideration
36 :			* \param area is the area that the prey consumption is being calculated on
37 :			* \param TimeInfo is the TimeClass for the current model
38 :			*/
39 :			virtual void adjustConsumption(int area, const TimeClass* const TimeInfo);
40 :			/**
41 :			* \brief This function will print the predator information
42 :			* \param outfile is the ofstream that all the model information gets sent to
43 :			*/
44 :			virtual void Print(ofstream& outfile) const;
45 :			};
46 :
47 :			#endif

---

root@forge.cesga.es	ViewVC Help
Powered by ViewVC 1.0.0