THare Class Reference

The base class for all hare classes. More...

#include <Hare_All.h>

Inheritance diagram for THare:

Public Member Functions
	THare (int p_x, int p_y, Landscape *p_L, THare_Population_Manager *p_PPM)
	Constructor. More...
void	THareInit (int p_x, int p_y, THare_Population_Manager *p_PPM)
	Object Initiation. More...
	~THare () override
	Destructor. More...
virtual TTypeOfHareState	st_Dispersal ()
	Base implementation only - reimplemented. More...
void	BeginStep (void) override
	Base implementation only - reimplemented. More...
void	Step (void) override
	Base implementation only - reimplemented. More...
void	EndStep (void) override
	Base implementation only - reimplemented. More...
double	GetWeight ()
double	GetTotalWeight ()
	Provide the wet weight of the hare. More...
int	GetAge ()
	Provide the age of the hare. More...
void	ON_MumDead (Hare_Female *a_Mum)
	Inform Mum that we are dead. More...
Hare_Female *	GetMum ()
	Get the mother pointer. More...
double	GetRMR ()
	Get todays RMR. More...
virtual bool	WasPredated ()
	Test for predation. More...
int	GetRefNum ()
	Get the refnum for this hare. More...
virtual void	ON_Dead (void)
	Mortality - overridden in descendent classes. More...
void	loadVegPalatability (void)
	Loads static member m_vegPalatability with data. More...
Public Member Functions inherited from TAnimal
	TAnimal (int x, int y, Landscape *L)
	The TAnimal constructor saving the x,y, location and the landscape pointer. More...
	TAnimal (int x, int y)
	The TAnimal constructor saving the x,y used if landscape is already set. More...
void	SetGuardMapIndex (int a_index_x, int a_index_y)
	Set the guard map index, this is used to avoid two animals operating in the same location when using multithread. More...
unsigned	SupplyFarmOwnerRef () const
	Get the current location farm ref if any. More...
AnimalPosition	SupplyPosition () const
	Returns the objects location and habitat type and veg type. More...
APoint	SupplyPoint () const
	Returns the objects location in ALMaSS coordinates. More...
int	SupplyPolygonRef () const
	Returns the polygon reference where the object is located. More...
TTypesOfLandscapeElement	SupplyPolygonType () const
	Returns the polygon type where the object is located. More...
int	Supply_m_Location_x () const
	Returns the ALMaSS x-coordinate. More...
int	Supply_m_Location_y () const
	Returns the ALMaSS y-coordinate. More...
int	SupplyGuardCellX () const
	Returns the x-index to the guard cell. More...
int	SupplyGuardCellY () const
	Returns the y-index to the guard cell. More...
int	SupplyAge () const
	Returns the animals age in days. More...
void	SetAge (int a_age)
	Sets the animals age in days. More...
virtual void	KillThis ()
	Sets all parameters ready for object destruction. More...
virtual void	CopyMyself ()
	Used to copy the object details to another in descendent classes. More...
void	SetX (const int a_x)
	Sets the x-coordinate. More...
void	SetY (const int a_y)
	Sets the y-coordinate. More...
virtual void	ReinitialiseObject (int a_x, int a_y, Landscape *a_l_ptr)
virtual void	ReinitialiseObject (int a_x, int a_y)
	Used to re-use an object - must be implemented in descendent classes. More...
virtual int	WhatState ()
	Returns the objects current state number. More...
virtual void	Dying ()
	A wrapped for KillThis - ideally should not be used. More...
void	CheckManagement ()
	Used to start a check for any management related effects at the objects current location. More...
void	CheckManagementXY (int a_x, int a_y)
	Used to start a check for any management related effects at x,y. More...
Public Member Functions inherited from TALMaSSObject
int	GetCurrentStateNo () const
	Returns the current state number. More...
void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...
bool	GetStepDone () const
	Returns the step done indicator flag. More...
void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...
void	ReinitialiseObjectBase ()
	Used to initialise an object. More...
	TALMaSSObject ()
	The constructor for TALMaSSObject. More...
virtual	~TALMaSSObject ()=default
	The destructor for TALMaSSObject. More...

Static Public Member Functions
static void	SetMum (Hare_Female *)
	Set the mother pointer. Reimplemented in Hare_Infant. More...
Static Public Member Functions inherited from TAnimal
static void	SetSimulationWidth (int a_value)
	Sets the simulation width. More...
static void	SetSimulationHeight (int a_value)
	Sets the simulation height. More...
static void	SetDayInYear (int a_value)
	Sets the day in year attribute. More...
static void	SetOurLandscape (Landscape *a_value)
	Sets the landscape pointer. More...
static void	SetTempToday (double a_value)
	Sets the temperature today attribute. More...
Static Public Member Functions inherited from TALMaSSObject
static void	OnArrayBoundsError ()
	Used for debugging only, tests basic object properties. More...

Static Public Attributes
static double *	m_vegPalatability = nullptr
	Will hold and array of palatability for hare for each tov type. Most are 1, but unpalatable vegetation can be specified here. More...

Protected Member Functions
bool	Run (int a_dist, int a_direction)
	Run a distance in a direction. More...
void	EnergyBalance (TTypeOfActivity a_activity, int dist)
	Adjust energy balance for an activity. More...
void	TimeBudget (TTypeOfActivity a_activity, int dist)
	Adjust time budger for an activity. More...
void	st_Dying ()
	Tidy up before removing the object on death. More...
virtual void	Running (int a_max_dist)
	Run. More...
void	Walking (int a_dist, int a_direction)
	Walking. More...
double	Forage (int &time)
	Foraging. More...
double	ForageP (int &time)
	Foraging but also incorporating pesticide exposure. More...
virtual void	InternalPesticideHandlingAndResponse ()
	Handles internal effects of pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes. More...
virtual void	GeneralEndocrineDisruptor (double)
	Handles internal effects of endocrine distrupter pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes. More...
virtual void	GeneralOrganoPhosphate (double)
	Handles internal effects of organophosphate pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes. More...
double	ForageSquare (int a_x, int a_y)
	Forage from an area. More...
double	ForageSquareP (int a_x, int a_y, double *a_pestexposure)
	Forage from an area and resturn pesticide exposure as well as food. More...
int	GetPegDistance ()
	Get peg distance. More...
int	GetPegPull ()
	Get attractive force of peg. More...
int	GetPegDirection ()
	Get direction of peg. More...
void	MovePeg ()
	Move the peg according to attraction forces. More...
bool	OnFarmEvent (FarmToDo event) override
	Do we require a response to a farm event. More...
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
TTypeOfHareState	m_CurrentHState
	Defines the current activity. More...
int	m_Age = 0
	State variale - hare age. More...
Hare_Object	m_Type
	State variale - the type of hare. More...
double	m_weight = 0.0
	State variale - hare weight g. More...
double	m_old_weight = 0.0
	State variale - last hare weight. More...
Hare_Female *	m_MyMum = nullptr
	Pointer to the hare's mum. More...
THare_Population_Manager *	m_OurPopulationManager
	Pointer to the hare population manager. More...
int	m_Lifespan = 0
	Physiolocal lifespan, assuming nothing else kills the hare (unlikely to reach this age) More...
int	m_ActivityTime = 0
	Minutes of potential activity time per day. More...
int	m_StarvationDays = 0
	State variable - the number of consecutive days in negative energy balance. More...
double	m_fatReserve = 0.0
	State variable - the energy reserve of the hare. More...
double	m_TodaysEnergy = 0.0
	State variable - the amount of energy available today, can be in deficit. More...
double	m_EnergyMax = 0.0
	State variable - the amount of energy it is possible to eat as a multiplyer or RMR. More...
double	m_KJRunning = 0.0
	KJ/m cost of running per kg hare. More...
double	m_KJWalking = 0.0
	KJ/m cost of walking per kg hare. More...
double	m_KJForaging = 0.0
	KJ/m cost of foraging per kg hare. More...
double	m_SpeedRunning = 0.0
	m/min speed of running per kg hare More...
double	m_SpeedWalking = 0.0
	m/min speed of walking per kg hare More...
double	m_foragingenergy = 0.0
	Energy obtained from foraging/feeding. More...
int	m_peg_x = 0
	peg x-coordinate More...
int	m_peg_y = 0
	peg y-coordinate More...
int	m_RefNum = 0
	Unique hare reference number, also functions as sex flag. More...
int	m_experiencedDensity = 0
	State variable used in alternative density-dependent configurations. More...
int	m_lastYearsDensity = 0
	State variable used in alternative density-dependent configurations. More...
int	m_ddindex = 0
	State variable used in alternative density-dependent configurations. More...
int	m_expDensity [365] = {}
	State variable used in alternative density-dependent configurations. More...
int	m_DensitySum = 0
	State variable used in alternative density-dependent configurations. More...
bool	m_IamSick = false
	flag for sickness - used in conjunction with disease configurations More...
double	m_pesticide_burden = 0.0
	State variable used to hold the current body-burden of pesticide. More...
double	m_pesticidedegradationrate = 0.0
	State variable used to hold the daily degredation rate of the pesticide in the body. More...
bool	m_pesticideInfluenced1 = false
	Flag to indicate pesticide effects (e.g. can be used for endocrine distruptors with delayed effects until birth). More...
Protected Attributes inherited from TAnimal
int	m_Location_x
	The objects ALMaSS x coordinate. More...
int	m_Location_y
	The objects ALMaSS y coordinate. More...
int	m_guard_cell_x
	The index x to the guard cell. More...
int	m_guard_cell_y
	The index y to the guard cell. More...
int	m_AgeDays {0}
	To hold the age in days. More...
PesticideToxicity	m_my_pesticide
Protected Attributes inherited from TALMaSSObject
int	m_CurrentStateNo
	The basic state number for all objects - '-1' indicates death. More...
bool	m_StepDone
	Indicates whether the iterative step code is done for this timestep. More...

Additional Inherited Members
Static Protected Attributes inherited from TAnimal
static Landscape *	m_OurLandscape = nullptr
	A pointer to the landscape object shared with all TAnimal objects. More...
static int	m_SimulationWidth = 0
	A static member for the simulation width because it is often used by descendent classes. More...
static int	m_SimulationHeight = 0
	A static member for the simulation height because it is often used by descendent classes. More...
static double	m_TemperatureToday = 0.0
	A holder for the temperature today shared with all TAnimal objects. More...
static int	m_DayInYear = 0
	A holder for the day in year shared with all TAnimal objects. More...

Detailed Description

The base class for all hare classes.

Constructor & Destructor Documentation

THare()

THare::THare	(	int	p_x,
		int	p_y,
		Landscape *	p_L,
		THare_Population_Manager *	p_PPM
	)

Constructor.

THare constructor code

                                                     : TAnimal(p_x, p_y)
{
    THareInit(p_x, p_y, p_PPM);
}

References THareInit().

~THare()

THare::~THare ( )

override

Destructor.

THare destructor

{
}

Member Function Documentation

BeginStep()

void THare::BeginStep ( void  )

inlineoverridevirtual

Base implementation only - reimplemented.

Reimplemented from TALMaSSObject.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, and Hare_Infant.

                                  {
    }

EndStep()

void THare::EndStep ( void  )

inlineoverridevirtual

Base implementation only - reimplemented.

Reimplemented from TALMaSSObject.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, and Hare_Infant.

{ MovePeg(); }

References MovePeg().

EnergyBalance()

void THare::EnergyBalance ( TTypeOfActivity  a_activity, int  dist  )

protected

Adjust energy balance for an activity.

This method calculates energy used and subtracts this from the fat store.
The fat store is KJ so no conversion is required here. The fat store can only be a maximum X% of the body weight

{
  switch (a_activity)
  {
    case activity_Resting:
      m_TodaysEnergy-=m_OurPopulationManager->GetRMR(m_Age,GetTotalWeight());
      break;
    case activity_Running:
      // Note here it is the fatReserve that is altered
      // This is because this activity could be called at anytime, and we
      // do not know if m_TodaysEnergy is set to anything sensible. fatReserve is
      // always sensible though. Note this will potentially influence behaviour
      // if running causes a low fatReserve.
      m_fatReserve-=dist*m_KJRunning;    // dist in metres
      break;
    case activity_Dispersal:
      m_TodaysEnergy-=dist*m_KJWalking;  // dist in metres
      break;
    case activity_Walking:
      m_TodaysEnergy-=dist*m_KJWalking;  // dist in metres
      break;
    case activity_Foraging:
      m_TodaysEnergy-=dist*m_KJForaging; // dist in minutes
      // Checking code
      m_foragingenergy+=dist*m_KJForaging;
      break;
    default:
      m_OurLandscape->Warn("THare::EnergyBalance - unknown activity",NULL);
      exit(1);
  }
}

References activity_Dispersal, activity_Foraging, activity_Resting, activity_Running, activity_Walking, THare_Population_Manager::GetRMR(), GetTotalWeight(), m_Age, m_fatReserve, m_foragingenergy, m_KJForaging, m_KJRunning, m_KJWalking, TAnimal::m_OurLandscape, m_OurPopulationManager, m_TodaysEnergy, and Landscape::Warn().

Referenced by Forage(), ForageP(), Running(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), Hare_Juvenile::st_Dispersal(), Hare_Young::st_Resting(), and Hare_Juvenile::st_Resting().

Forage()

double THare::Forage ( int &  time )

protected

Foraging.

This could be implemented in each hare's st_Foraging, but is implemented as a common method because all the hares do it the same way. This method determine how much energy can be foraged from the current location in the time available (a_time).
It is important that energy used for foraging is deducted from the energybudget calculations before calculating the target - otherwise growth will be affected.
Efficiency can be roughly calculated for optimal forage by calculating the number squares and the cost of foraging together with the return. e.g. 100m2 -> 10m2 forage with ext of 5.0 = 50KJ at a cost of 100*m_KJForaging.
Hence return can be calculated and the target adjusted accordingly

m_EnergyMax is the max amount of energy possible in one day (intake/cfg_hare_ExtEff to reduce calculations). This needs to be no more than they ever need, the closer to this limit the faster the code will run due to avoiding unnecessary searching, but also will prevent high energy usage being offset by too high intake. m_EnergyMax is set at the beginnng of each day in BeginStep.

{
    #define __SQRS 100 // __SQRS is the number of m2 foraged per forage square
    int y_add[8] = { -10, -10, 0, 10, 10, 10, 0, -10 }; // N,NE,E,SE,S,SW,W,NW
    int x_add[8] = {  0,  10, 10, 10, 0, -10, -10, -10 }; // N,NE,E,SE,S,SW,W,NW
    unsigned next=0;
    double food[8];
    int bestsquare = 0;
    // Get the top corner of our square
    int x=m_Location_x;
    int y=m_Location_y;
    // Search central square
    double TotalFood = ForageSquare(x,y); // this calls walking automatically
    a_time -= __SQRS;
    EnergyBalance(activity_Foraging, __SQRS * 5); // Assume a 20cm swath, therefore distance = 5 * m2
    if ((a_time - __SQRS)<0)
    {
        return TotalFood;
    }
    // Set up searching for the next 8 squares around this one
    food[0]=0;
    int equal=0;
    double best=-1;
    for (int i=0; i<8; i++) 
    {
        x = m_Location_x+x_add[i];
        y = m_Location_y+y_add[i];
        food[i]=ForageSquare(x,y);
        if (food[i]>best) {
            best=food[i];
            equal=0;
            bestsquare=i;
        } else if (food[i]==best) 
        {
            equal++;
        }
    }
    if (equal>0) 
    { 
        // No real direction to move in, so go towards our peg if this is OK
        unsigned pd=(GetPegDirection());
        // Our normal directions are 0-7 N,NE,E,SE,S,SW,W,NW        //
        if (food[pd] == best) bestsquare=pd;
        else {
            pd= (pd-1) & 0x07;
            if (food[pd] == best) bestsquare=pd;
            else {
                // First check the directions
                bestsquare=-1;
                while (bestsquare==-1) 
                {
                    int t=g_random_fnc(8);
                    if (food[t]==best) bestsquare=t;
                }
            }
        }
    }
    // Now move to the next square, also the best in food return
    a_time -= __SQRS;
    EnergyBalance(activity_Foraging, __SQRS * 5);
    Walking(10, bestsquare);
    TotalFood+=food[bestsquare];
    if (TotalFood>=m_EnergyMax)
    {
        return m_EnergyMax;
    }
    // OK now dependent upon the direction bestsquare, we need to check 3 or 5 new squares for food
    while (a_time>0) 
    {
        int nsqs;
        int subtract=1+(bestsquare & 1);
        if ( subtract == 1) nsqs = 3; else nsqs = 5;
        for (int j=0; j<nsqs; j++) {
            next=((bestsquare-subtract)+j) & 7;
            x = m_Location_x+x_add[next];
            y = m_Location_y+y_add[next];
            food[j]=ForageSquare(x,y);
            TotalFood+=food[j];
            a_time -= __SQRS;
            EnergyBalance(activity_Foraging, __SQRS*5);
        }
        // Choose the best
        int found=0;
        //bestsquare=0;
        for (int j=1; j<nsqs; j++) {
            if (food[j]>food[found]) found=j;
            else if (food[j]==food[found]) {
              if (g_random_fnc(3)==0) {
                  found=j;
              }
          }
        }
        bestsquare=((bestsquare-subtract)+found) & 7;
        if (GetPegPull()> g_random_fnc(cfg_hare_pegmoveto_chance.value())) 
        {
            bestsquare=(GetPegDirection());
            // Our normal directions are 0-7 N,NE,E,SE,S,SW,W,NW
        }
        //
        Walking(10,bestsquare);
        if (TotalFood>m_EnergyMax) {
            return m_EnergyMax;
        }
    }
    if (TotalFood > m_EnergyMax)
    {
        TotalFood = m_EnergyMax;
    }
    return TotalFood;
}

References __SQRS, activity_Foraging, cfg_hare_pegmoveto_chance, EnergyBalance(), ForageSquare(), g_random_fnc(), GetPegDirection(), GetPegPull(), m_EnergyMax, TAnimal::m_Location_x, TAnimal::m_Location_y, CfgInt::value(), and Walking().

Referenced by Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), and Hare_Female::st_Foraging().

ForageP()

double THare::ForageP ( int &  time )

protected

Foraging but also incorporating pesticide exposure.

This could be implemented in each hare's st_Foraging, but is implemented as a common method because all the hares do it the same way. This method determine how much energy can be foraged from the current location in the time available (a_time).
It is important that energy used for foraging is deducted from the energybudget calculations before calculating the target - otherwise growth will be affected.
Efficiency can be roughly calculated for optimal forage by calculating the number squares and the cost of foraging together with the return. e.g. 100m2 -> 10m2 forage with ext of 5.0 = 50KJ at a cost of 100*m_KJForaging. Hence return can be calculated and the target adjusted accordingly
The only difference between this method and THare::Forage is that this one calls the version of ForageSquare that also calculates pesticide exposure.

m_EnergyMax is the max amount of energy possible in one day. This needs to be no more than they ever need, the closer to this limit the faster the code will run due to avoiding unnecessary searching, but also will prevent high energy usage being offset by too high intake. m_EnergyMax is set at the beginnng of each day in BeginStep.

{
    #define __SQRS 100 // __SQRS is the number of m2 foraged per forage square
    int y_add[8] = { -10, -10, 0, 10, 10, 10, 0, -10 }; // N,NE,E,SE,S,SW,W,NW
    int x_add[8] = { 0, 10, 10, 10, 0, -10, -10, -10 }; // N,NE,E,SE,S,SW,W,NW
    unsigned next = 0;
    double food[8];
    double pesticide[8];
    int bestsquare = 0;
    // Get the top corner of our square
    int x = m_Location_x;
    int y = m_Location_y;
    // Search central square
    double PesticideExposure = 0.0;
    double TotalFood = ForageSquareP(x, y, &PesticideExposure); // this calls walking automatically
    a_time -= __SQRS;
    EnergyBalance(activity_Foraging, __SQRS * 5); // Assume a 20cm swath, therefore distance = 5 * m2
    if ((a_time - __SQRS)<0)
    {
        m_pesticide_burden += PesticideExposure;
        return TotalFood;
    }
    // Set up searching for the next 8 squares around this one
    food[0] = 0;
    int equal = 0;
    double best = -1;
    double tempP;
    for (int i = 0; i<8; i++)
    {
        x = m_Location_x + x_add[i];
        y = m_Location_y + y_add[i];
        tempP = 0.0;
        food[i] = ForageSquareP(x, y, &tempP);
        pesticide[i] = tempP;
        if (food[i]>best) {
            best = food[i];
            equal = 0;
            bestsquare = i;
        }
        else if (food[i] >= best)
        {
            equal++;
        }
    }
    if (equal>0)
    {
        // No real direction to move in, so go towards our peg if this is OK
        unsigned pd = (GetPegDirection());
        // Our normal directions are 0-7 N,NE,E,SE,S,SW,W,NW        //
        if (food[pd] >= best) bestsquare = pd;
        else {
            pd = (pd - 1) & 0x07;
            if (food[pd] >= best) bestsquare = pd;
            else {
                // First check the directions
                bestsquare = -1;
                while (bestsquare == -1)
                {
                    int t = g_random_fnc(8);
                    if (food[t] >= best) bestsquare = t;
                }
            }
        }
    }
    // Now move to the next square, also the best in food return
    Walking(10, bestsquare);
    a_time -= __SQRS;
    EnergyBalance(activity_Foraging, __SQRS * 5);
    TotalFood += food[bestsquare];
    PesticideExposure += pesticide[bestsquare];
    if (TotalFood >= m_EnergyMax)
    {
        m_pesticide_burden += PesticideExposure;
        return TotalFood;
    }
    // OK now dependent upon the direction bestsquare, we need to check 3 or 5 new squares for food
    while (a_time>0)
    {
        int nsqs;
        int subtract = 1 + (bestsquare & 1);
        if (subtract == 1) nsqs = 3; else nsqs = 5;
        for (int j = 0; j<nsqs; j++) {
            next = ((bestsquare - subtract) + j) & 7;
            x = m_Location_x + x_add[next];
            y = m_Location_y + y_add[next];
            food[j] = ForageSquareP(x, y, &PesticideExposure);
            TotalFood += food[j];
            a_time -= __SQRS;
            EnergyBalance(activity_Foraging, __SQRS * 5);
        }
        // Choose the best
        int found = 0;
        //bestsquare=0;
        for (int j = 1; j<nsqs; j++) {
            if (food[j]>food[found]) found = j;
            else if (food[j] == food[found]) {
                if (g_random_fnc(3) == 0) {
                    found = j;
                }
            }
        }
        bestsquare = ((bestsquare - subtract) + found) & 7;
        if (GetPegPull()> g_random_fnc(cfg_hare_pegmoveto_chance.value()))
        {
            bestsquare = (GetPegDirection());
            // Our normal directions are 0-7 N,NE,E,SE,S,SW,W,NW
        }
        //
        Walking(10, bestsquare);
        if (TotalFood>m_EnergyMax) {
            m_pesticide_burden += PesticideExposure;
            return TotalFood;
        }
    }
    if (TotalFood > m_EnergyMax)
    {
        TotalFood = m_EnergyMax;
    }
    m_pesticide_burden += PesticideExposure;
    return TotalFood;
}

References __SQRS, activity_Foraging, cfg_hare_pegmoveto_chance, EnergyBalance(), ForageSquareP(), g_random_fnc(), GetPegDirection(), GetPegPull(), m_EnergyMax, TAnimal::m_Location_x, TAnimal::m_Location_y, m_pesticide_burden, CfgInt::value(), and Walking().

Referenced by Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), and Hare_Female::st_Foraging().

ForageSquare()

double THare::ForageSquare ( int  a_x, int  a_y  )

protected

Forage from an area.

{
    int polyref;
    double food=0.0;
    int sw=m_OurLandscape->SupplySimAreaWidth();
    int sh=m_OurLandscape->SupplySimAreaHeight();
    // Do the search and return the value
    // Now we need the irritating boundary check
    if ((a_x >= sw-10) || (a_y > sh-10) || (a_x < 0 ) || (a_y < 0)) 
    {
        // We check __FSQRS% of the cell and assume that the hare can find forage matching the best square
        for (int i=0; i<__FSQRS; i++) 
        {
            // Here is the boundary check
            int x = (sw+a_x+g_random_fnc(10)) % sw;
            int y = (sh+a_y+g_random_fnc(10)) % sh;
            // All OK now, so get the polygon information and food
            polyref=m_OurLandscape->SupplyPolyRef(x,y);
            double f=m_OurPopulationManager->GetPolyFood(polyref);
            if (f < 0.0)
            {
                TTypesOfCrops toc = m_OurLandscape->SupplyCropType(polyref);
                // if we are a field do this
                if (toc != toc_None) f = m_OurLandscape->GetHareFoodQuality(polyref) * m_vegPalatability[toc];
                else f = m_OurLandscape->GetHareFoodQuality(polyref); // not a field
                m_OurPopulationManager->SetPolyFood(polyref,f);
            }
             food+=f; //Changed foraging methods - now find the best sample cell and assume the whole square is this good - allows focus in foraging
            //if (f > food) food = f;
 
        }
    } else 
    {
        for (int i=0; i<__FSQRS; i++) 
        {
            int x = a_x+g_random_fnc(10);
            int y = a_y+g_random_fnc(10);
            polyref=m_OurLandscape->SupplyPolyRef(x,y);
            double f=m_OurPopulationManager->GetPolyFood(polyref);
            if (f <  0.0)
            {
                TTypesOfCrops toc = m_OurLandscape->SupplyCropType(polyref);
                // if we are a field do this
                if (toc != toc_None) f = m_OurLandscape->GetHareFoodQuality(polyref) * m_vegPalatability[toc];
                else f = m_OurLandscape->GetHareFoodQuality(polyref); // not a field
            }
            food+=f; //Changed foraging methods - now find the best sample cell and assume the whole square is this good - allows focus in foraging
            //if (f > food) food = f;
        }
    }
    return food * 10 * cfg_hare_ExtEff.value(); // Assume they eat from all 100 m2 at this rate
}

References __FSQRS, cfg_hare_ExtEff, g_random_fnc(), Landscape::GetHareFoodQuality(), THare_Population_Manager::GetPolyFood(), TAnimal::m_OurLandscape, m_OurPopulationManager, m_vegPalatability, THare_Population_Manager::SetPolyFood(), Landscape::SupplyCropType(), Landscape::SupplyPolyRef(), Landscape::SupplySimAreaHeight(), Landscape::SupplySimAreaWidth(), toc_None, and CfgFloat::value().

Referenced by Forage().

ForageSquareP()

double THare::ForageSquareP ( int  a_x, int  a_y, double *  a_pestexposure  )

protected

Forage from an area and resturn pesticide exposure as well as food.

{
    int polyref;
    double somepesticide = 0.0;
    double food = 0.0;
    int sw = m_OurLandscape->SupplySimAreaWidth();
    int sh = m_OurLandscape->SupplySimAreaHeight();
    // Do the search and return the value
    // Now we need the irritating boundary check
    if ((a_x >= sw - 10) || (a_y > sh - 10) || (a_x < 0) || (a_y < 0))
    {
        // We check __FSQRS% of the cell and assume that the hare can find forage matching the best square
        for (int i = 0; i<__FSQRS; i++) 
        {
            // Here is the boundary check
            int x = (sw + a_x + g_random_fnc(10)) % sw;
            int y = (sh + a_y + g_random_fnc(10)) % sh;
            // All OK now, so get the polygon information and food
            polyref = m_OurLandscape->SupplyPolyRef(x, y);
            somepesticide += m_OurLandscape->SupplyPesticideP(x, y, ppp_1);
            double f = m_OurPopulationManager->GetPolyFood(polyref);
            if (f < 0.0)
            {
                TTypesOfCrops toc = m_OurLandscape->SupplyCropType(polyref);
                // if we are a field do this
                if (toc != toc_None) f = m_OurLandscape->GetHareFoodQuality(polyref) * m_vegPalatability[toc];
                else f = m_OurLandscape->GetHareFoodQuality(polyref); // not a field
            }
            food += f; //Changed foraging methods - now find the best sample cell and assume the whole square is this good - allows focus in foraging
        }
    }
    else
    {
        for (int i = 0; i<__FSQRS; i++)
        {
            int x = a_x + g_random_fnc(10);
            int y = a_y + g_random_fnc(10);
            polyref = m_OurLandscape->SupplyPolyRef(x, y);
            somepesticide += m_OurLandscape->SupplyPesticideP(x, y, ppp_1);
            double f = m_OurPopulationManager->GetPolyFood(polyref); // returns -1 if not already set
            if (f < 0.0)
            {
                TTypesOfCrops toc = m_OurLandscape->SupplyCropType(polyref);
                // if we are a field do this
                if (toc != toc_None) f = m_OurLandscape->GetHareFoodQuality(polyref) * m_vegPalatability[toc];
                else f = m_OurLandscape->GetHareFoodQuality(polyref); // not a field
            }
            food += f;
        }
    }
    // somepesticide now has the pesticide exposure in units per 10m2, but we need 100m and there are two routes with different rates of intake, so first X10
    somepesticide *= 10;
    // contact exposure
    (*a_pesticideexposure) += somepesticide * cfg_hare_pesticide_contact_exposure_rate.value();
    // ingestion exposure
    (*a_pesticideexposure) += somepesticide * cfg_hare_pesticide_ingestion_exposure_rate.value();
    return food * 10 * cfg_hare_ExtEff.value(); // Assume they eat from all 100 m2 at this rate
}

References __FSQRS, cfg_hare_ExtEff, cfg_hare_pesticide_contact_exposure_rate, cfg_hare_pesticide_ingestion_exposure_rate, g_random_fnc(), Landscape::GetHareFoodQuality(), THare_Population_Manager::GetPolyFood(), TAnimal::m_OurLandscape, m_OurPopulationManager, m_vegPalatability, ppp_1, Landscape::SupplyCropType(), Landscape::SupplyPesticideP(), Landscape::SupplyPolyRef(), Landscape::SupplySimAreaHeight(), Landscape::SupplySimAreaWidth(), toc_None, and CfgFloat::value().

Referenced by ForageP().

GeneralEndocrineDisruptor()

virtual void THare::GeneralEndocrineDisruptor ( double  )

inlineprotectedvirtual

Handles internal effects of endocrine distrupter pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes.

Reimplemented in Hare_Male, and Hare_Female.

                                                     {
    }

GeneralOrganoPhosphate()

virtual void THare::GeneralOrganoPhosphate ( double  )

inlineprotectedvirtual

Handles internal effects of organophosphate pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes.

Reimplemented in Hare_Male, and Hare_Female.

                                                  {
    }

GetAge()

int THare::GetAge ( )

inline

Provide the age of the hare.

{ return m_Age; }

References m_Age.

Referenced by THare_Population_Manager::DoFirst(), and Hare_Female::DoLactation().

GetMum()

Hare_Female* THare::GetMum ( )

inline

Get the mother pointer.

{ return m_MyMum; }

References m_MyMum.

Referenced by Hare_Female::SanityCheckYoungList().

GetPegDirection()

int THare::GetPegDirection ( )

inlineprotected

Get direction of peg.

Daily movement is limited by a peg which does not really want to move, but can be dragged slowly. This requires a set of rapid functions because they will be used a lot. NB dispersal takes no account of the peg.
Figures out the closest direction to peg.
1 NE, 3 SE, 5 SWest & 7 NW
only uses 4 returns because this is very fast and relatively simple - 8 directions would be quite difficult to implement fast
This is also complicated by the fact that the peg can be at the other end of the world due to wrap around.

{
    int d1 = m_Location_x - m_peg_x;
      int d2 = m_Location_y - m_peg_y;
      if ((d1 == 0) && (d2 == 0)) return g_random_fnc(8);
      if (abs(d1) > (int)m_OurPopulationManager->SupplySimWH())
      {
          if (d1<0) 
          {
              if ( abs(d2) > (int) m_OurPopulationManager->SupplySimHH())
              {
                  if (d2<0) return 7; //NW;
                  else return 5; //SW;
              }
              else 
              {
                  if (d2<0) return 5; //SW;
                  else return 7; //NW;
              }
          }
          else 
          {
              if ( abs(d2) > (int) m_OurPopulationManager->SupplySimHH()) 
              {
                  if (d2<0) return 1; //NE;
                  else return 3; //SE;
              }
              else {
                  if (d2<0) return 3; //SE;
                  else return 1; //NE;
              }
          }
      }
      else 
      {
          if (d1<0) 
          {
              if ( abs(d2) > (int) m_OurPopulationManager->SupplySimHH())
              {
                  if (d2<0) return 1; //NE;
                  else return 3; //SE;
              }
              else {
                  if (d2<0) return 3; //SE;
                  else return 1; //NE;
              }
          }
          else {
              if ( abs(d2) > (int) m_OurPopulationManager->SupplySimHH()) {
                  if (d2<0) return 7; //NW;
                  else return 5; //SW;
              }
              else {
                  if (d2<0) return 5; //SW;
                  else return 7; //NW;
              }
          }
      }
}

References g_random_fnc(), TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulationManager, m_peg_x, m_peg_y, Population_Manager_Base::SupplySimHH(), and Population_Manager_Base::SupplySimWH().

Referenced by Forage(), and ForageP().

GetPegDistance()

int THare::GetPegDistance ( )

inlineprotected

Get peg distance.

Daily movement is limited by a peg which does not really want to move, but can be dragged slowly. This requires a set of rapid functions because they will be used a lot. NB dispersal takes no account of the peg.
Calculates the distance from our current x,y to the peg We must avoid sqrt and the like so our distance is in rectangular co-ordinates. This is complicated by the fact that the peg and hare may be on opposite sides of the world due to wrap around.

{
      int d1=abs(m_Location_x-m_peg_x);
      if (d1 > (int) m_OurPopulationManager->SupplySimWH()) d1 = abs(d1-m_OurPopulationManager->SupplySimW());
      int d2=abs(m_Location_y-m_peg_y);
      if (d2 > (int) m_OurPopulationManager->SupplySimWH()) d2 = abs(d2-m_OurPopulationManager->SupplySimH());
      return d1+d2;
}

References TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulationManager, m_peg_x, m_peg_y, Population_Manager_Base::SupplySimH(), Population_Manager_Base::SupplySimW(), and Population_Manager_Base::SupplySimWH().

Referenced by GetPegPull().

GetPegPull()

int THare::GetPegPull ( )

inlineprotected

Get attractive force of peg.

Returns the squared rectangular distance from the peg

{
    int d = GetPegDistance();
        return d*d;
}

References GetPegDistance().

Referenced by Forage(), and ForageP().

GetRefNum()

int THare::GetRefNum ( )

inline

Get the refnum for this hare.

{ return m_RefNum; }

References m_RefNum.

GetRMR()

double THare::GetRMR

(

)

Get todays RMR.

Gets the hare RMR based on age and mass

                     {
       return m_OurPopulationManager->GetRMR(m_Age,GetTotalWeight());
}

References THare_Population_Manager::GetRMR(), GetTotalWeight(), m_Age, and m_OurPopulationManager.

Referenced by Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), and Hare_Female::BeginStep().

GetTotalWeight()

double THare::GetTotalWeight ( )

inline

Provide the wet weight of the hare.

Uses a standard multiplier of 3.8 to convert dry to wet weight, then adds the fat (no water here).

{ return m_weight * 3.8 + m_fatReserve; }

References m_fatReserve, and m_weight.

Referenced by EnergyBalance(), GetRMR(), Hare_Infant::st_Developing(), and Hare_Young::st_Foraging().

GetWeight()

double THare::GetWeight ( )

inline

Provide the weight of the hare.

{ return m_weight; }

References m_weight.

InternalPesticideHandlingAndResponse()

void THare::InternalPesticideHandlingAndResponse ( )

protectedvirtual

Handles internal effects of pesticide exposure. If any effects are needed this method must be re-implemented by descendent classes.

This method needs to be re-implemented for any class which has pesticide response behaviour. e.g. see Hare_Female::InternalPesticideHandlingAndResponse

Reimplemented in Hare_Female, and Hare_Male.

  {
      m_pesticide_burden *= m_pesticidedegradationrate; // Does nothing by default except internal degredation of the pesticide
  }

References m_pesticide_burden, and m_pesticidedegradationrate.

Referenced by Hare_Young::EndStep(), and Hare_Juvenile::EndStep().

loadVegPalatability()

void THare::loadVegPalatability

(

void

)

Loads static member m_vegPalatability with data.

{
    m_vegPalatability = new double[ toc_Foobar ];
    
    hare_tov_SetVegPalatability(m_vegPalatability);
}

References hare_tov_SetVegPalatability(), m_vegPalatability, and toc_Foobar.

MovePeg()

void THare::MovePeg ( )

protected

Move the peg according to attraction forces.

Daily movement is limited by a peg which does not really want to move, but can be dragged slowly. This requires a set of rapid functions because they will be used a lot. NB dispersal takes no account of the peg.
Moves the peg towards the location, the speed of movement is dependent upon an inertia parameter.
Once again we have the problem of wrap around.

{
      //
      // Find the distance between the peg & x,y and add a fixed proportion to move peg
      int d1=(m_Location_x-m_peg_x);
      if (abs(d1)< (int) m_OurPopulationManager->SupplySimWH()) m_peg_x += int(d1*g_hare_peg_inertia); // Global used for speed
      else {
          if (d1<0) d1+=m_OurPopulationManager->SupplySimWH(); else d1-=m_OurPopulationManager->SupplySimWH();
          m_peg_x += int(d1*g_hare_peg_inertia);
      }
      d1=(m_Location_y-m_peg_y);
      if (abs(d1)< (int) m_OurPopulationManager->SupplySimHH()) m_peg_y += int(d1*g_hare_peg_inertia);
      else {
          if (d1<0) d1+=m_OurPopulationManager->SupplySimHH(); else d1-=m_OurPopulationManager->SupplySimHH();
          m_peg_y += int(d1*g_hare_peg_inertia);
      }
  }

References g_hare_peg_inertia, TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulationManager, m_peg_x, m_peg_y, Population_Manager_Base::SupplySimHH(), and Population_Manager_Base::SupplySimWH().

Referenced by EndStep(), Hare_Infant::EndStep(), Hare_Young::EndStep(), Hare_Juvenile::EndStep(), Hare_Male::EndStep(), and Hare_Female::EndStep().

ON_Dead()

virtual void THare::ON_Dead ( void  )

inlinevirtual

Mortality - overridden in descendent classes.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, and Hare_Infant.

                               {
    }

ON_MumDead()

void THare::ON_MumDead ( Hare_Female *  a_Mum )

inline

Inform Mum that we are dead.

Really a Hare_Infant method. Implemented here because it is needed only for debug.

                                        {
        if (a_Mum != m_MyMum)
        {
            m_OurLandscape->Warn("Hare_Infant::On_MumDead  - not my mum!!", "");
            exit(1);
        }
        // I am now an orphan
        m_MyMum = nullptr;
    }

References m_MyMum, TAnimal::m_OurLandscape, and Landscape::Warn().

OnFarmEvent()

bool THare::OnFarmEvent ( FarmToDo  event )

overrideprotectedvirtual

Do we require a response to a farm event.

Checks to see if any nasty farm event has caused any behaviour. Few do directly, most work by changes in vegetation or forage, but if they do they can be added here

Reimplemented from TAnimal.

Reimplemented in Hare_Young, and Hare_Infant.

{
    if (event != sleep_all_day)
    {
        Running(cfg_hare_escape_dist.value());
        return true; // This will ensure that the next event checked is sensible.
    }
}

References cfg_hare_escape_dist, Running(), sleep_all_day, and CfgInt::value().

Run()

bool THare::Run ( int  a_dist, int  a_direction  )

protected

Run a distance in a direction.

{
  // Need to move a_dist in direction a_direction
  int Width=m_OurPopulationManager->SupplySimW();
  int Height=m_OurPopulationManager->SupplySimH();
  int tx=m_Location_x;
  int ty=m_Location_y;
  switch(a_direction)
  {
    case 0: // North
      ty=m_Location_y-a_dist;
      if (ty<0) ty+=Height;
      break;
    case 1: // NorthWest
      // OK, OK I know, I should reduce the distance for the diagonal - but it
      // costs two multiplications if I do, and this is used a lot
      ty=m_Location_y-a_dist;
      tx=m_Location_x+a_dist;
      if (ty<0) ty+=Height;
      if (tx>=Width) tx-=Width;
      break;
    case 2: // West
      tx=m_Location_x+a_dist;
      if (tx>=Width) tx-=Width;
      break;
      case 3: // SouthWest
        ty=m_Location_y+a_dist;
        tx=m_Location_x+a_dist;
        if (tx>=Width) tx-=Width;
        if (ty>=Height) ty-=Height;
        break;
    case 4: // South
      ty=m_Location_y+a_dist;
      if (ty>=Height) ty-=Height;
      break;
    case 5: // SouthEast
      ty=m_Location_y+a_dist;
      tx=m_Location_x-a_dist;
      if (tx<0) tx+=Width;
      if (ty>=Height) ty-=Height;
      break;
    case 6: // East
      tx=m_Location_x-a_dist;
      if (tx<0) tx+=Width;
      break;
    case 7: // NorthEast
      ty=m_Location_y-a_dist;
      tx=m_Location_x-a_dist;
      if (tx<0) tx+=Width;
      if (ty<0) ty+=Height;
      break;
    default: // No direction
      break;
 
  }
  // Now just before we do anything, check that we can go to tx,ty
  if ( hare_tole_can_walkacross(m_OurLandscape, tx, ty) )
  {
      m_Location_x = tx;
      m_Location_y = ty;
      //check the guard map for the new location
        m_OurPopulationManager->UpdateGuardMap(m_Location_x, m_Location_y, m_guard_cell_x, m_guard_cell_y);
      return true;
  }
  else
  {
      return false;
  }
 
  // I know I can save code by only testing for boundary conditions
  // at the end, but 50% of the time this will involve an unnecessary test and
  // speed usually being the problem I think it is better this way
}

References hare_tole_can_walkacross(), TAnimal::m_guard_cell_x, TAnimal::m_guard_cell_y, TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, m_OurPopulationManager, Population_Manager_Base::SupplySimH(), Population_Manager_Base::SupplySimW(), and Population_Manager::UpdateGuardMap().

Referenced by Running(), and Walking().

Running()

void THare::Running ( int  a_max_dist )

protectedvirtual

Run.

Moves the hare and alters the energy and time budget to simulate running /n All proximity alerts or other causes of running for all hares are sent via this code - the code then calls a movement code and energetic code. However these are may not the same for all hare types, so if there is a specific routine for a type, that is called, if not the default is used - there is no need to worry about this as the calling program.

{
   int dist;
   bool b;
   //remove it from the density map at current location
   m_OurPopulationManager->SubtractHareDensity(m_Location_x, m_Location_y, m_Type);
   
   // The length of this loop can cause problems, hence in very small landscapes max_dist has to be small. A minimum distance was not used because this invites infinite looping.
   do {
    // Choose a distance......
    dist=a_max_dist;
    // and see if it is possible to go there in a random direction
    b=Run(a_max_dist++, g_random_fnc(8));
   } while (b==false);
 
  m_OurPopulationManager->UpdateGuardMap(m_Location_x, m_Location_y, m_guard_cell_x, m_guard_cell_y);
  //add it to the density map at new location
  m_OurPopulationManager->AddHareDensity(m_Location_x, m_Location_y, m_Type);
  
 
   // Now adjust our energy balance
   EnergyBalance(activity_Running, dist);
   TimeBudget(activity_Running, dist);
   TimeBudget(activity_Recovery, cfg_Hare_Recovery_Time.value());
}

References activity_Recovery, activity_Running, THare_Population_Manager::AddHareDensity(), cfg_Hare_Recovery_Time, EnergyBalance(), g_random_fnc(), TAnimal::m_guard_cell_x, TAnimal::m_guard_cell_y, TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulationManager, m_Type, Run(), THare_Population_Manager::SubtractHareDensity(), TimeBudget(), Population_Manager::UpdateGuardMap(), and CfgInt::value().

Referenced by Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), and OnFarmEvent().

SetMum()

static void THare::SetMum ( Hare_Female *  )

inlinestatic

Set the mother pointer. Reimplemented in Hare_Infant.

                                       {
    }

Referenced by THare_Population_Manager::CreateObjects().

st_Dispersal()

TTypeOfHareState THare::st_Dispersal ( void  )

virtual

Base implementation only - reimplemented.

This function is really a dummy - but it needs to be here.
The return values is meaningless, but stops the compiler complaining

Reimplemented in Hare_Female, Hare_Juvenile, and Hare_Young.

{
  return tohs_InitialState;
}

References tohs_InitialState.

st_Dying()

void THare::st_Dying ( void  )

protected

Tidy up before removing the object on death.

Do the housekeeping necessary to die

                     {
    if (m_MyMum) m_MyMum->ON_YoungKilled(this);
    m_CurrentHState=tohs_DestroyObject;
    m_CurrentStateNo=-1;
    m_MyMum=NULL;
    m_StepDone=true;
}

References m_CurrentHState, TALMaSSObject::m_CurrentStateNo, m_MyMum, TALMaSSObject::m_StepDone, Hare_Female::ON_YoungKilled(), and tohs_DestroyObject.

Referenced by Hare_Infant::ON_Dead(), and Hare_Young::ON_Dead().

Step()

void THare::Step ( void  )

inlineoverridevirtual

Base implementation only - reimplemented.

Reimplemented from TALMaSSObject.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, and Hare_Infant.

                             {
    }

THareInit()

void THare::THareInit	(	int	p_x,
		int	p_y,
		THare_Population_Manager *	p_PPM
	)

Object Initiation.

{
  // The THare constructor - only needs to know about the Hare Population
  // Manager
  m_OurPopulationManager=p_PPM;
  m_CurrentHState=tohs_InitialState;
  // Set the lifespan
  m_Lifespan=cfg_hare_max_age.value()+(g_random_fnc(cfg_hare_max_age_var.value()*2)-cfg_hare_max_age_var.value());
  // Energetic values - these can be overwritten by the constructor of
  // descendent classes
  m_KJRunning=0;
  m_KJWalking=0;
  m_KJForaging=0;
  m_SpeedRunning=cfg_Hare_StdSpeedRunning.value();
  m_SpeedWalking=cfg_Hare_StdSpeedWalking.value();
  m_fatReserve=0;
  m_StarvationDays=0;
  m_TodaysEnergy=0;
  //m_in_dispersal = false;
  //m_TimePerForageSquare= 13 * 13; // 24 squares
  m_ActivityTime=1440; // In the case of object creation, this cannot be set in the begin step
  m_foragingenergy=0.001; // a bit more than 0
  m_peg_x=p_x;
  m_peg_y=p_y;
  m_lastYearsDensity=0;
  m_experiencedDensity=0;
  for (int i=0; i<365; i++) m_expDensity[i]=0;
  m_DensitySum=0;
  m_ddindex=0;
  m_RefNum=p_PPM->GetHareRefNum();
  m_pesticideInfluenced1 = false;
  m_pesticide_burden = 0.0;
  m_pesticidedegradationrate = cfg_hare_pesticidedegradationrate.value(); // default of 0.0 will remove all body burden pesticide at the end of each day
}

References cfg_hare_max_age, cfg_hare_max_age_var, cfg_hare_pesticidedegradationrate, cfg_Hare_StdSpeedRunning, cfg_Hare_StdSpeedWalking, g_random_fnc(), THare_Population_Manager::GetHareRefNum(), m_ActivityTime, m_CurrentHState, m_ddindex, m_DensitySum, m_expDensity, m_experiencedDensity, m_fatReserve, m_foragingenergy, m_KJForaging, m_KJRunning, m_KJWalking, m_lastYearsDensity, m_Lifespan, m_OurPopulationManager, m_peg_x, m_peg_y, m_pesticide_burden, m_pesticidedegradationrate, m_pesticideInfluenced1, m_RefNum, m_SpeedRunning, m_SpeedWalking, m_StarvationDays, m_TodaysEnergy, tohs_InitialState, CfgInt::value(), and CfgFloat::value().

Referenced by Hare_Infant::ReInit(), Hare_Young::ReInit(), Hare_Juvenile::ReInit(), Hare_Male::ReInit(), Hare_Female::ReInit(), and THare().

TimeBudget()

void THare::TimeBudget ( TTypeOfActivity  a_activity, int  dist  )

protected

Adjust time budger for an activity.

This method calculates time used for each activity and subtracts this from the day

{
  switch (a_activity)
  {
    case activity_Resting:
      m_ActivityTime-=dist; // dist is in time here (minutes)
      break;
    case activity_Running:
      m_ActivityTime-=(int)(dist/m_SpeedRunning);  // dist in metres
      break;
    case activity_Walking:
      m_ActivityTime-=(int)(dist/m_SpeedWalking); // dist in metres
      break;
    case activity_Foraging:
      m_ActivityTime-=dist; // dist in minutes
      break;
    case activity_Dispersal:
        m_ActivityTime -= (int)(dist / m_SpeedWalking); // dist in metres 
      break;
    case activity_Recovery:
      m_ActivityTime-=dist; // dist in minutes
      break;
    default:
      m_OurLandscape->Warn("THare::TimeBudget - unknown activity",NULL);
      exit(1);
  }
}

References activity_Dispersal, activity_Foraging, activity_Recovery, activity_Resting, activity_Running, activity_Walking, m_ActivityTime, TAnimal::m_OurLandscape, m_SpeedRunning, m_SpeedWalking, and Landscape::Warn().

Referenced by Running(), Hare_Juvenile::st_Dispersal(), Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), Hare_Female::st_Foraging(), Hare_Young::st_Resting(), and Hare_Juvenile::st_Resting().

Walking()

void THare::Walking ( int  a_dist, int  a_direction  )

protected

Walking.

Moves the hare and alters the energy budget to simulate walking.

{
    while (!Run(a_dist, a_direction)) {
        a_direction=g_random_fnc(8);
        //a_dist=random(500); // This is just for cases like Illum� where it is possible to travel too far in all directions
        a_dist--; // This is because hares can get stuck otherwise.
    }
}

References g_random_fnc(), and Run().

Referenced by Forage(), ForageP(), and Hare_Juvenile::st_Dispersal().

WasPredated()

bool THare::WasPredated ( )

virtual

Test for predation.

A mortality test. Also include optional code for size and low fat reserve increased mortality - tested under the POM

Reimplemented in Hare_Juvenile.

                        {
    // This is only called by adult states, so don't call it from any other hare class
#ifdef __SIZERELATEDDEATH2
    if (m_weight<cfg_hare_minimum_breeding_weight.value()) test*=2;
#endif
#ifdef __LOWFATRELATEDDEATH
    if (m_Age>365) if (m_fatReserve<1.0) {
        test= (int)(cfg_hare_lowfatextramort.value() * test); // Increase the chance of dying if fat reserves drop to low levels
    }
#endif
    if (g_rand_uni_fnc()<m_OurPopulationManager->m_AdultMortRate) return true;
    return false;
}

References cfg_hare_lowfatextramort, cfg_hare_minimum_breeding_weight, g_rand_uni_fnc(), THare_Population_Manager::m_AdultMortRate, m_Age, m_fatReserve, m_OurPopulationManager, m_weight, CfgInt::value(), and CfgFloat::value().

Member Data Documentation

m_ActivityTime

int THare::m_ActivityTime = 0

protected

Minutes of potential activity time per day.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), Hare_Female::st_Foraging(), Hare_Young::st_Resting(), Hare_Juvenile::st_Resting(), THareInit(), and TimeBudget().

m_Age

int THare::m_Age = 0

protected

State variale - hare age.

Referenced by Hare_Male::BeginStep(), Hare_Female::BeginStep(), EnergyBalance(), GetAge(), GetRMR(), Hare_Infant::Init(), Hare_Young::Init(), Hare_Juvenile::Init(), Hare_Male::Init(), Hare_Female::Init(), Hare_Juvenile::ShouldMature(), Hare_Infant::st_Developing(), Hare_Young::st_Developing(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), Hare_Young::st_Foraging(), Hare_Infant::st_NextStage(), Hare_Juvenile::st_NextStage(), and WasPredated().

m_CurrentHState

TTypeOfHareState THare::m_CurrentHState

protected

Defines the current activity.

Inherits m_Location_x, m_Location_y, m_OurLandscape and general step behaviour from TAnimal

Referenced by Hare_Young::BeginStep(), Hare_Infant::EndStep(), Hare_Young::EndStep(), Hare_Male::GeneralOrganoPhosphate(), Hare_Female::GeneralOrganoPhosphate(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), st_Dying(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), Hare_Female::Step(), and THareInit().

m_ddindex

int THare::m_ddindex = 0

protected

State variable used in alternative density-dependent configurations.

Referenced by Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), and THareInit().

m_DensitySum

int THare::m_DensitySum = 0

protected

State variable used in alternative density-dependent configurations.

Referenced by Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), and THareInit().

m_EnergyMax

double THare::m_EnergyMax = 0.0

protected

State variable - the amount of energy it is possible to eat as a multiplyer or RMR.

Referenced by Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Forage(), and ForageP().

m_expDensity

int THare::m_expDensity[365] = {}

protected

State variable used in alternative density-dependent configurations.

Referenced by Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), and THareInit().

m_experiencedDensity

int THare::m_experiencedDensity = 0

protected

State variable used in alternative density-dependent configurations.

Referenced by Hare_Male::BeginStep(), Hare_Female::BeginStep(), and THareInit().

m_fatReserve

double THare::m_fatReserve = 0.0

protected

State variable - the energy reserve of the hare.

Referenced by Hare_Female::DoLactation(), Hare_Female::dumpEnergy(), EnergyBalance(), GetTotalWeight(), Hare_Male::Init(), Hare_Female::Init(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), THareInit(), Hare_Female::UpdateGestation(), Hare_Female::UpdateOestrous(), and WasPredated().

m_foragingenergy

double THare::m_foragingenergy = 0.0

protected

Energy obtained from foraging/feeding.

Referenced by Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Female::dumpEnergy(), EnergyBalance(), and THareInit().

m_IamSick

bool THare::m_IamSick = false

protected

flag for sickness - used in conjunction with disease configurations

Referenced by Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Female::Init(), and Hare_Female::UpdateOestrous().

m_KJForaging

double THare::m_KJForaging = 0.0

protected

KJ/m cost of foraging per kg hare.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), EnergyBalance(), Hare_Female::Init(), and THareInit().

m_KJRunning

double THare::m_KJRunning = 0.0

protected

KJ/m cost of running per kg hare.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), EnergyBalance(), Hare_Female::Init(), and THareInit().

m_KJWalking

double THare::m_KJWalking = 0.0

protected

KJ/m cost of walking per kg hare.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), EnergyBalance(), Hare_Female::Init(), and THareInit().

m_lastYearsDensity

int THare::m_lastYearsDensity = 0

protected

State variable used in alternative density-dependent configurations.

Referenced by Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Male::st_Foraging(), Hare_Female::st_Foraging(), and THareInit().

m_Lifespan

int THare::m_Lifespan = 0

protected

Physiolocal lifespan, assuming nothing else kills the hare (unlikely to reach this age)

Referenced by Hare_Male::BeginStep(), Hare_Female::BeginStep(), and THareInit().

m_MyMum

Hare_Female* THare::m_MyMum = nullptr

protected

Pointer to the hare's mum.

Referenced by Hare_Infant::BeginStep(), GetMum(), ON_MumDead(), Hare_Infant::SetMum(), st_Dying(), Hare_Infant::st_NextStage(), and Hare_Young::st_NextStage().

m_old_weight

double THare::m_old_weight = 0.0

protected

State variale - last hare weight.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Infant::Init(), Hare_Female::Init(), Hare_Infant::st_Developing(), and Hare_Young::st_Developing().

m_OurPopulationManager

THare_Population_Manager* THare::m_OurPopulationManager

protected

Pointer to the hare population manager.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Female::DoLactation(), EnergyBalance(), ForageSquare(), ForageSquareP(), GetPegDirection(), GetPegDistance(), GetRMR(), Hare_Female::GiveBirth(), Hare_Female::Init(), Hare_Male::InternalPesticideHandlingAndResponse(), Hare_Female::InternalPesticideHandlingAndResponse(), MovePeg(), Run(), Running(), Hare_Infant::st_Developing(), Hare_Young::st_Developing(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), Hare_Juvenile::st_Dispersal(), Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), Hare_Female::st_Foraging(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), THareInit(), WasPredated(), and Hare_Juvenile::WasPredated().

m_peg_x

int THare::m_peg_x = 0

protected

peg x-coordinate

Referenced by GetPegDirection(), GetPegDistance(), MovePeg(), Hare_Female::st_Dispersal(), and THareInit().

m_peg_y

int THare::m_peg_y = 0

protected

peg y-coordinate

Referenced by GetPegDirection(), GetPegDistance(), MovePeg(), Hare_Female::st_Dispersal(), and THareInit().

m_pesticide_burden

double THare::m_pesticide_burden = 0.0

protected

State variable used to hold the current body-burden of pesticide.

Referenced by ForageP(), InternalPesticideHandlingAndResponse(), Hare_Male::InternalPesticideHandlingAndResponse(), Hare_Female::InternalPesticideHandlingAndResponse(), and THareInit().

m_pesticidedegradationrate

double THare::m_pesticidedegradationrate = 0.0

protected

State variable used to hold the daily degredation rate of the pesticide in the body.

Referenced by InternalPesticideHandlingAndResponse(), Hare_Male::InternalPesticideHandlingAndResponse(), Hare_Female::InternalPesticideHandlingAndResponse(), and THareInit().

m_pesticideInfluenced1

bool THare::m_pesticideInfluenced1 = false

protected

Flag to indicate pesticide effects (e.g. can be used for endocrine distruptors with delayed effects until birth).

Referenced by Hare_Female::GeneralEndocrineDisruptor(), Hare_Female::GiveBirth(), and THareInit().

m_RefNum

int THare::m_RefNum = 0

protected

Unique hare reference number, also functions as sex flag.

Referenced by GetRefNum(), Hare_Male::Init(), Hare_Female::Init(), Hare_Juvenile::st_NextStage(), and THareInit().

m_SpeedRunning

double THare::m_SpeedRunning = 0.0

protected

m/min speed of running per kg hare

Referenced by THareInit(), and TimeBudget().

m_SpeedWalking

double THare::m_SpeedWalking = 0.0

protected

m/min speed of walking per kg hare

Referenced by THareInit(), and TimeBudget().

m_StarvationDays

int THare::m_StarvationDays = 0

protected

State variable - the number of consecutive days in negative energy balance.

Referenced by Hare_Infant::st_Developing(), Hare_Young::st_Developing(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), and THareInit().

m_TodaysEnergy

double THare::m_TodaysEnergy = 0.0

protected

State variable - the amount of energy available today, can be in deficit.

Referenced by Hare_Female::dumpEnergy(), EnergyBalance(), Hare_Infant::ON_BeingFed(), Hare_Infant::st_Developing(), Hare_Young::st_Developing(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), Hare_Young::st_Foraging(), Hare_Juvenile::st_Foraging(), Hare_Male::st_Foraging(), Hare_Female::st_Foraging(), and THareInit().

m_Type

Hare_Object THare::m_Type

protected

State variale - the type of hare.

Referenced by Hare_Infant::Init(), Hare_Young::Init(), Hare_Juvenile::Init(), Hare_Male::Init(), Hare_Female::Init(), Running(), and Hare_Juvenile::st_Dispersal().

m_vegPalatability

double * THare::m_vegPalatability = nullptr

static

Will hold and array of palatability for hare for each tov type. Most are 1, but unpalatable vegetation can be specified here.

Referenced by ForageSquare(), ForageSquareP(), loadVegPalatability(), Hare_Juvenile::st_Dispersal(), and THare_Population_Manager::~THare_Population_Manager().

m_weight

double THare::m_weight = 0.0

protected

State variale - hare weight g.

Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Female::dumpEnergy(), GetTotalWeight(), GetWeight(), Hare_Infant::Init(), Hare_Young::Init(), Hare_Juvenile::Init(), Hare_Male::Init(), Hare_Female::Init(), Hare_Male::InternalPesticideHandlingAndResponse(), Hare_Female::InternalPesticideHandlingAndResponse(), Hare_Infant::SetWeight(), Hare_Infant::st_Developing(), Hare_Young::st_Developing(), Hare_Juvenile::st_Developing(), Hare_Male::st_Developing(), Hare_Female::st_Developing(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), Hare_Female::st_ReproBehaviour(), Hare_Female::UpdateOestrous(), and WasPredated().

---

The documentation for this class was generated from the following files:

• /builds/ALMaSS/ALMaSS_MIDox/Hare/Hare_All.h
• /builds/ALMaSS/ALMaSS_MIDox/Hare/Hare_All.cpp
• /builds/ALMaSS/ALMaSS_MIDox/Hare/Hare_THare.cpp
• /builds/ALMaSS/ALMaSS_MIDox/Hare/HareForagenPeg.cpp