Revision 1 -
(download)
(annotate)
Mon Feb 10 17:09:07 2014 UTC
(10 years, 5 months ago)
by agomez File size: 1971 byte(s)
Initial version based on Gadget 2.2.00
#ifndef linearpredator_h
#define linearpredator_h
#include "lengthpredator.h"
/**
* \class LinearPredator
* \brief This is the class used to model the predation of stocks by a fleet that will catch a proportion of the available biomass
*/
class LinearPredator : public LengthPredator {
public:
/**
* \brief This is the LinearPredator constructor
* \param infile is the CommentStream to read the predation parameters from
* \param givenname is the name of the predator
* \param Areas is the IntVector of areas that the predator lives on
* \param TimeInfo is the TimeClass for the current model
* \param keeper is the Keeper for the current model
* \param multscaler is the Formula that can be used to scale the biomass consumed
*/
LinearPredator(CommentStream& infile, const char* givenname, const IntVector& Areas,
const TimeClass* const TimeInfo, Keeper* const keeper, Formula multscaler);
/**
* \brief This is the default LinearPredator destructor
*/
virtual ~LinearPredator() {};
/**
* \brief This will calculate the amount the predator consumes on a given area
* \param area is the area that the prey consumption is being calculated on
* \param Area is the AreaClass for the current model
* \param TimeInfo is the TimeClass for the current model
*/
virtual void Eat(int area, const AreaClass* const Area, const TimeClass* const TimeInfo);
/**
* \brief This will adjust the amount the predator consumes on a given area, to take oversconsumption into consideration
* \param area is the area that the prey consumption is being calculated on
* \param TimeInfo is the TimeClass for the current model
*/
virtual void adjustConsumption(int area, const TimeClass* const TimeInfo);
/**
* \brief This function will print the predator information
* \param outfile is the ofstream that all the model information gets sent to
*/
virtual void Print(ofstream& outfile) const;
};
#endif