gadget2/reference/base_8h_source.html

 #ifndef base_h

 #define base_h


 #include "areatime.h"

 #include "hasname.h"

 #include "livesonareas.h"


 class BaseClass : public HasName, public LivesOnAreas {

 public:

   BaseClass() {};

   BaseClass(const char* givenname) : HasName(givenname) {};

   BaseClass(const char* givenname, const IntVector& Areas) : HasName(givenname), LivesOnAreas(Areas) {};

   virtual ~BaseClass() {};

   virtual void calcNumbers(int area, const TimeClass* const TimeInfo) = 0;

   virtual void calcEat(int area, const AreaClass* const Area, const TimeClass* const TimeInfo) = 0;

   virtual void checkEat(int area, const TimeClass* const TimeInfo) = 0;

   virtual void adjustEat(int area, const TimeClass* const TimeInfo) = 0;

   virtual void reducePop(int area, const TimeClass* const TimeInfo) = 0;

   virtual void Grow(int area, const AreaClass* const Area, const TimeClass* const TimeInfo) = 0;

   virtual void updateAgePart1(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updateAgePart2(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updateAgePart3(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updatePopulationPart1(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updatePopulationPart2(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updatePopulationPart3(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updatePopulationPart4(int area, const TimeClass* const TimeInfo) = 0;

   virtual void updatePopulationPart5(int area, const TimeClass* const TimeInfo) = 0;

   virtual void Migrate(const TimeClass* const TimeInfo) = 0;

   virtual void Reset(const TimeClass* const TimeInfo) = 0;

   virtual void Print(ofstream& outfile) const = 0;

 };


 #endif

areatime.h

AreaClass
This is the class used to store information about the areas used for the current model.
Definition: areatime.h:18

BaseClass
This is the base class for any object that can be dynamically modelled within Gadget.
Definition: base.h:13

BaseClass::updateAgePart1
virtual void updateAgePart1(int area, const TimeClass *const TimeInfo)=0
This function will calculate any transition of the model population for an area in the model.

BaseClass::updateAgePart2
virtual void updateAgePart2(int area, const TimeClass *const TimeInfo)=0
This function will calculate the age increase of the model population for an area in the model.

BaseClass::calcEat
virtual void calcEat(int area, const AreaClass *const Area, const TimeClass *const TimeInfo)=0
This function will calculate the modelled consumption for an area in the model.

BaseClass::updatePopulationPart5
virtual void updatePopulationPart5(int area, const TimeClass *const TimeInfo)=0
This function will calculate add the strayed stock into the model population for an area in the model...

BaseClass::calcNumbers
virtual void calcNumbers(int area, const TimeClass *const TimeInfo)=0
This function will update the model population for an area in the model.

BaseClass::BaseClass
BaseClass(const char *givenname, const IntVector &Areas)
This is the BaseClass constructor for an object with a name and an area.
Definition: base.h:29

BaseClass::Print
virtual void Print(ofstream &outfile) const =0
This function will print the model population.

BaseClass::Reset
virtual void Reset(const TimeClass *const TimeInfo)=0
This function will reset the model population.

BaseClass::updateAgePart3
virtual void updateAgePart3(int area, const TimeClass *const TimeInfo)=0
This function will implement the transiton of the model population for an area in the model.

BaseClass::checkEat
virtual void checkEat(int area, const TimeClass *const TimeInfo)=0
This function will check the modelled consumption for an area in the model.

BaseClass::Migrate
virtual void Migrate(const TimeClass *const TimeInfo)=0
This function will implement the migration of the model population for the model.

BaseClass::BaseClass
BaseClass()
This is the default BaseClass constructor.
Definition: base.h:18

BaseClass::Grow
virtual void Grow(int area, const AreaClass *const Area, const TimeClass *const TimeInfo)=0
This function will calculate the growth of the model population for an area in the model.

BaseClass::reducePop
virtual void reducePop(int area, const TimeClass *const TimeInfo)=0
This function will reduce the model population for an area in the model.

BaseClass::~BaseClass
virtual ~BaseClass()
This is the default BaseClass destructor.
Definition: base.h:33

BaseClass::adjustEat
virtual void adjustEat(int area, const TimeClass *const TimeInfo)=0
This function will adjust the modelled consumption for an area in the model.

BaseClass::updatePopulationPart4
virtual void updatePopulationPart4(int area, const TimeClass *const TimeInfo)=0
This function will calculate calculate the straying of the model population for an area in the model.

BaseClass::updatePopulationPart1
virtual void updatePopulationPart1(int area, const TimeClass *const TimeInfo)=0
This function will calculate the spawning of the model population for an area in the model.

BaseClass::updatePopulationPart2
virtual void updatePopulationPart2(int area, const TimeClass *const TimeInfo)=0
This function will calculate add the newly matured stock into the model population for an area in the...

BaseClass::updatePopulationPart3
virtual void updatePopulationPart3(int area, const TimeClass *const TimeInfo)=0
This function will calculate add the new recruits into the model population for an area in the model.

BaseClass::BaseClass
BaseClass(const char *givenname)
This is the BaseClass constructor for an object with a name.
Definition: base.h:23

HasName
This is the base class for any object that has a name.
Definition: hasname.h:10

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

LivesOnAreas
This is the class used to store information about the areas an object is defined on for the current m...
Definition: livesonareas.h:10

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

hasname.h

livesonareas.h