gadget2/reference/stockprey_8h_source.html

 #ifndef stockprey_h

 #define stockprey_h


 #include "prey.h"

 #include "agebandmatrixptrvector.h"


 class StockPrey : public Prey {

 public:

   StockPrey(CommentStream& infile, const IntVector& Areas,

     const char* givenname, int minage, int numage,

     const TimeClass* const TimeInfo, Keeper* const keeper);

   virtual ~StockPrey() {};

   virtual void Sum(const AgeBandMatrix& stockAlkeys, int area);

   virtual void Print(ofstream& outfile) const;

   int minAge() const { return preyAlkeys[0].minAge(); };

   int maxAge() const { return preyAlkeys[0].maxAge(); };

   AgeBandMatrix& getConsumptionALK(int area) { return preyAlkeys[this->areaNum(area)]; };

 protected:

   AgeBandMatrixPtrVector preyAlkeys;

 };


 #endif

agebandmatrixptrvector.h

AgeBandMatrixPtrVector
This class implements a dynamic vector of AgeBandMatrix values.
Definition: agebandmatrixptrvector.h:12

AgeBandMatrix
This class implements a vector of PopInfoIndexVector values, indexed from minage not 0.
Definition: agebandmatrix.h:15

CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40

IntVector
This class implements a dynamic vector of int values.
Definition: intvector.h:11

Keeper
This is the class used to store information about the variables that are used in model simulation.
Definition: keeper.h:17

LivesOnAreas::areaNum
int areaNum(int area) const
This function will return the area associated with an internal area.
Definition: livesonareas.cc:33

Prey
This is the base class used to model the consumption of a prey.
Definition: prey.h:27

StockPrey
This is the class used to model a dynamic prey based on a modelled stock.
Definition: stockprey.h:11

StockPrey::maxAge
int maxAge() const
This will return the maximum age of the prey.
Definition: stockprey.h:50

StockPrey::preyAlkeys
AgeBandMatrixPtrVector preyAlkeys
This is the AgeBandMatrixPtrVector used to store the amount of the prey on each area.
Definition: stockprey.h:56

StockPrey::getConsumptionALK
AgeBandMatrix & getConsumptionALK(int area)
This function will return the amount of prey on the area before consumption.
Definition: stockprey.h:56

StockPrey::Print
virtual void Print(ofstream &outfile) const
This function will print the prey information.
Definition: stockprey.cc:30

StockPrey::StockPrey
StockPrey(CommentStream &infile, const IntVector &Areas, const char *givenname, int minage, int numage, const TimeClass *const TimeInfo, Keeper *const keeper)
This is the StockPrey constructor.
Definition: stockprey.cc:3

StockPrey::Sum
virtual void Sum(const AgeBandMatrix &stockAlkeys, int area)
This will calculate the amount of prey that is consumed for a given area and timestep.
Definition: stockprey.cc:17

StockPrey::~StockPrey
virtual ~StockPrey()
This is the default StockPrey destructor.
Definition: stockprey.h:29

StockPrey::minAge
int minAge() const
This will return the minimum age of the prey.
Definition: stockprey.h:45

TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87

prey.h