Vole_Base Class Reference

Base class for voles - all vole objects are descended from this class. More...

#include <vole_all.h>

Inheritance diagram for Vole_Base:

Public Member Functions
	Vole_Base (struct_Vole_Adult *a_AVoleStruct_ptr)
	Constructor for Vole_Base. More...
	~Vole_Base () override
virtual void	Init (struct_Vole_Adult *a_AVoleStruct_ptr)
virtual void	ReInit (struct_Vole_Adult *a_AVoleStruct_ptr)
void	BeginStep () override
	BeingStep behaviour - must be implemented in descendent classes. More...
void	Step () override
	Step behaviour - must be implemented in descendent classes. More...
void	EndStep () override
	All voles age at the end of the day. More...
void	st_Dying ()
	All voles end here on death. More...
void	SetBreedingSeason (bool a_flag)
	Set Breeding Season flag. More...
void	SetWeight (double W)
void	Setm_Mature ()
void	Set_BirthYear (int BirthYear)
void	Set_MotherId (unsigned MotherIdNo)
void	Set_FatherId (unsigned FatherIdNo)
void	Set_NoYoungTot (int a_NoOfYoung)
void	Set_XBorn (int a_Location_x)
void	Set_YBorn (int a_Location_y)
void	Set_ElemBorn (int a_Location_x, int a_Location_y)
void	Set_VegBorn (int a_Location_x, int a_Location_y)
void	Set_PolyRefBorn (int a_Location_x, int a_Location_y)
void	Set_Age (int Age)
int	WhatState () override
bool	SupplyBornLastYear ()
	Were we born this year? More...
bool	SupplyTerritorial ()
int	SupplyFatherId ()
int	SupplyMotherId ()
bool	SupplySex ()
int	SupplyBirthYear ()
int	SupplyTotNoYoung ()
int	SupplyXBorn ()
int	SupplyYBorn ()
int	SupplyPolyRefBorn ()
int	SupplyElemBorn ()
TTypesOfLandscapeElement	SupplyElemType ()
int	SupplyVegBorn ()
int	SupplyTerrRange ()
double	SupplyWeight ()
int	SupplyIDNo ()
bool	SupplyMature ()
int	SupplyDeathCause ()
unsigned	SupplyAge ()
unsigned	SupplyX ()
unsigned	SupplyY ()
bool	SupplyInTrap ()
InTrapPosition	SupplyTrapPosition ()
void	SetFree ()
int	SupplyHomoZyg ()
int	SupplyHeteroZyg ()
int	SupplyAllele (int locus, int allele)
uint32	SupplyMyAllele (int i, int j)
int	GetGeneticFlag ()
int	GetDirectFlag ()
void	SetGeneticFlag ()
void	SetDirectFlag ()
void	UnsetGeneticFlag ()
void	UnsetDirectFlag ()
GeneticMaterial	SupplyGenes ()
virtual void	OnKilled ()
virtual bool	MortalityTest ()
	Do a mortality test. More...
void	CopyMyself (VoleObject a_vole)
	Duplicates a vole. More...
void	SetFertile (bool f)
	Set the male vole fertility. More...
bool	GetFertile ()
	Get the male vole fertility. 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 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...
virtual bool	OnFarmEvent (FarmToDo)
	Must be reimplemented if used in descendent classes. Sets the action on a management event. 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...

Public Attributes
TTypeOfVoleState	CurrentVState
Vole_Population_Manager *	m_OurPopulation

Protected Member Functions
virtual void	RodenticideIngestion (void)
double	CalculateCarryingCapacity (int x, int y, int a_ddep) const
int	MoveQuality (int p_x, int p_y) const
	Test a location for quality while moving. More...
void	MoveTo (int p_Vector, int p_Distance, int iterations)
	Movement. More...
void	DoWalking (int p_Distance, int &p_Vector, int &vx, int &vy) const
	Walking. More...
void	DoWalkingCorrect (int p_Distance, int &p_Vector, int &vx, int &vy) const
	Walking where there is a danger of stepping off the world. More...
void	Escape (int p_Vector, int p_Distance)
	Dispersal - directed movement. More...
void	CheckTraps ()
virtual void	SetLocation ()
virtual void	FreeLocation ()
virtual bool	GetLocation (int, int)
Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Protected Attributes
int	m_BirthYear
bool	m_BornLastYear
	A flag set if the female was born the year before. More...
unsigned int	m_MinTerrRange
unsigned	m_MotherId
unsigned	m_FatherId
int	m_Death
int	m_TerrRange
bool	m_Sex
bool	m_Mature
int	m_Age
int	m_XBorn
int	m_YBorn
int	m_PolyRefBorn
int	m_ElemBorn
int	m_VegBorn
int	m_LifeSpan
double	m_Weight
bool	m_fertile
	Flag indicating the fertility state (true means fertile) More...
int	m_NoOfYoungTotal
int	m_DispVector
bool	m_Have_Territory
int	m_Reserves
unsigned	IDNo
int	m_SimH
int	m_SimW
GeneticMaterial	m_MyGenes
InTrapPosition	m_intrappos
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...

Static Protected Attributes
static unsigned int	m_MaxMaleTerritorySize = 0
static unsigned int	m_MaxFemaleTerritorySize = 0
static unsigned int	m_MinMaleTerritorySize = 0
static unsigned int	m_MinFemaleTerritorySize = 0
static double	m_MinFVoleHabQual = 0
static double	m_MinJMVoleHabQual = 0
static double	m_MinMVoleHabQual = 0
static double	m_MaleTerritoryRangeSlope = 0
static double	m_FemaleTerritoryRangeSlope = 0
static double	m_FHabQualThreshold3
static double	m_FHabQualThreshold2
static double	m_FHabQualThreshold1
static double	m_MHabQualThreshold3
static double	m_MHabQualThreshold2
static double	m_MHabQualThreshold1
static bool	m_BreedingSeason = false
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...

Additional Inherited Members
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...

Detailed Description

Base class for voles - all vole objects are descended from this class.

Constructor & Destructor Documentation

Vole_Base()

Vole_Base::Vole_Base

(

struct_Vole_Adult *

a_AVoleStruct_ptr

)

Constructor for Vole_Base.

: TAnimal(a_AVoleStruct_ptr->x, a_AVoleStruct_ptr->y) { Init(a_AVoleStruct_ptr); }

References Init().

~Vole_Base()

Vole_Base::~Vole_Base ( )

override

                      {
}

Member Function Documentation

BeginStep()

void Vole_Base::BeginStep ( void  )

inlineoverridevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.

                              {
    };

CalculateCarryingCapacity()

double Vole_Base::CalculateCarryingCapacity ( int  p_x, int  p_y, int  a_ddep  ) const

protected

Returns the sum of the qualities in the area covered by the territory (even if the vole does not have one)

Uses the algorithm for fast searching of square arrays with wrap around co-ordinates.
parameters = x,y starting coordinates top left
range = extent of the space to search
bottom left coordinate is therefore x+range, y+range
22/09/2000

For each polygon it gets the quality and multiplies by area of that polygon in the territory. This is summed for all polygons in the territoryto get overall quality. The value is then divided by the number of voles present less a threshold value.

                                                                              {
    int NoPolygons = 0;
    int PolyRefData[500][2];
    // First convert centre co-rdinates to square co-ordinates
    double quality = 0;
    int x = p_x - m_MinTerrRange;
    if (x < 0) x += m_SimW;
    int y = p_y - m_MinTerrRange;
    if (y < 0) y += m_SimH;
    const int range_x = m_MinTerrRange + m_MinTerrRange;
    const int range_y = m_MinTerrRange + m_MinTerrRange;
    // Stage 1 make a list of polygons
    // create the extent variables
    const int xextent0 = x + range_x;
    const int yextent0 = y + range_y;
    const int xextent1 = x + range_x - m_SimW;
    const int yextent1 = y + range_y - m_SimH;
    // Create the looping variables needed
    int Dfinx = xextent0;
    int Dfiny = yextent0;
    int Afinx = 0; // unless the finx values for A-C are changed
    int Bfinx = 0; // the value of zero will stop the A-C loops from executing
    int Cfinx = 0;
    int Afiny = 0; // this one assigned 0 to stop compiler complaints
    // Now create the loop values;
    if (x + range_x <= m_SimW)
    {
        // Type B & D (overlap bottom, no overlap)
        if (yextent0 > m_SimH)
        {
            // Type B (overlap bottom only)
            Dfiny = m_SimH;
            Bfinx = x + range_x;
        }
    }
    else
    {
        // Type A & C overlap left edge or bottom & left
        if (yextent0 > m_SimH)
        {
            // Type C overlap bottom and left
            Afinx = xextent1;
            Afiny = m_SimH;
            Bfinx = m_SimW;
            Cfinx = xextent1;
            Dfinx = m_SimW;
            Dfiny = m_SimH;
        }
        else
        {
            // Type A overlap left edge
            Afinx = xextent1;
            Afiny = yextent0;
            Dfinx = m_SimW;
        }
    }
    // the default is:
    // Type D no overlap
 
    // A Loop
    for (int i = 0; i < Afinx; i++)
    {
        for (int j = y; j < Afiny; j++)
        {
            // Get the polyref
            const int PRef = m_OurLandscape->SupplyPolyRefIndex(i, j);
            // check if we have had this one already
            bool found = false;
            for (int k = 0; k < NoPolygons; k++)
            {
                if (PolyRefData[k][0] == PRef)
                {
                    PolyRefData[k][1]++;
                    found = true;
                    break;
                }
            }
            if (!found)
            //*/
            {
                // don't have this one so get the height & type to the PolyDatas arrays
                PolyRefData[NoPolygons][0] = PRef;
                PolyRefData[NoPolygons][1] = 1;
                NoPolygons++;
            }
        }
    }
    // B Loop
    for (int i = x; i < Bfinx; i++)
    {
        for (int j = 0; j < yextent1; j++)
        {
            // Get the polyref
            const int PRef = m_OurLandscape->SupplyPolyRefIndex(i, j);
            // check if we have had this one already
            /*
                int index=-1;
                    for (int k=0; k<NoPolygons; k++)
                  {
                    if (PolyRefData[k][0]==PRef)
                    {
                      index=k;
                      break;
                    }
                  }
                  if (index!=-1)
                  {
                    PolyRefData[index][1]++;
                  }
                  else
            */
            bool found = false;
            for (int k = 0; k < NoPolygons; k++)
            {
                if (PolyRefData[k][0] == PRef)
                {
                    PolyRefData[k][1]++;
                    found = true;
                    break;
                }
            }
            if (!found)
            //*/
            {
                // don't have this one so get the height & type to the PolyDatas arrays
                PolyRefData[NoPolygons][0] = PRef;
                PolyRefData[NoPolygons][1] = 1;
                NoPolygons++;
            }
        }
    }
    // C Loop
    for (int i = 0; i < Cfinx; i++)
    {
        for (int j = 0; j < yextent1; j++)
        {
            // Get the polyref
            const int PRef = m_OurLandscape->SupplyPolyRefIndex(i, j);
            // check if we have had this one already
            /*
                int index=-1;
                    for (int k=0; k<NoPolygons; k++)
                  {
                    if (PolyRefData[k][0]==PRef)
                    {
                      index=k;
                      break;
                    }
                  }
                  if (index!=-1)
                  {
                    PolyRefData[index][1]++;
                  }
                  else
            */
            bool found = false;
            for (int k = 0; k < NoPolygons; k++)
            {
                if (PolyRefData[k][0] == PRef)
                {
                    PolyRefData[k][1]++;
                    found = true;
                    break;
                }
            }
            if (!found)
            //*/
            {
                // Don't have this one so get the height & type to the PolyDatas arrays
                PolyRefData[NoPolygons][0] = PRef;
                PolyRefData[NoPolygons][1] = 1;
                NoPolygons++;
            }
        }
    }
    // D Loop
    int last = -99999;
    int k_index = -1;
    for (int i = x; i < Dfinx; i++)
    {
        for (int j = y; j < Dfiny; j++)
        {
            // Get the polyref
            const int PRef = m_OurLandscape->SupplyPolyRefIndex(i, j);
            // check if we have had this one already
            if (last == PRef) { PolyRefData[k_index][1]++; }
            else
            {
                bool found = false;
                for (int k = 0; k < NoPolygons; k++)
                {
                    if (PolyRefData[k][0] == PRef)
                    {
                        PolyRefData[k][1]++;
                        found = true;
                        last = PRef;
                        k_index = k;
                        break;
                    }
                }
                if (!found)
                {
                    // don't have this one so get the height & type to the PolyDatas arrays
                    PolyRefData[NoPolygons][0] = PRef;
                    PolyRefData[NoPolygons][1] = 1;
                    NoPolygons++;
                }
            }
        }
    }
    // End of search algorithm
    /* for each polygon get the quality and multiply by amount of that polygon in the territory sum this to get overall quality */
    for (int i = 0; i < NoPolygons; i++) { quality += PolyRefData[i][1] * m_OurPopulation->GetHabitatQuality(PolyRefData[i][0]); }
    //    return quality;
 
    const int Voles = m_OurPopulation->SupplyHowManyVoles(m_Location_x, m_Location_y, m_TerrRange);
    if (Voles > a_ddep) quality /= Voles - a_ddep;
    // return the total quality
    return quality;
}

References Vole_Population_Manager::GetHabitatQuality(), TAnimal::m_Location_x, TAnimal::m_Location_y, m_MinTerrRange, TAnimal::m_OurLandscape, m_OurPopulation, m_SimH, m_SimW, m_TerrRange, Vole_Population_Manager::SupplyHowManyVoles(), and Landscape::SupplyPolyRefIndex().

Referenced by Vole_Male::CanFeed(), Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_JuvenileFemale::st_Evaluate_n_Explore(), Vole_Female::st_Evaluate_n_Explore(), and Vole_Female::st_Special_Explore().

CheckTraps()

void Vole_Base::CheckTraps ( )

protected

                           {
    if (m_OurLandscape->SupplyYearNumber() < 10) return; // Don't sample until the population has stabilised
    const int r = m_TerrRange;
    const int vx = m_Location_x;
    const int vy = m_Location_y;
    for (int rad = 0; rad < r; rad++)
    {
        // Two Loops
        for (int x = vx - rad; x <= vx + rad; x++)
        {
            int y = vy + rad;
            if (m_OurPopulation->IsTrap(x, y))
            {
                if (g_random_fnc(1) == 0)
                {
                    m_intrappos.m_x = x;
                    m_intrappos.m_y = y;
                    m_intrappos.m_EleType = m_OurLandscape->SupplyElementType(x, y);
                    m_intrappos.m_VegType = m_OurLandscape->SupplyVegType(x, y);
                    m_intrappos.m_inAtrap = true;
                    return;
                }
            }
            y = vy - rad;
            if (m_OurPopulation->IsTrap(x, y))
            {
                if (g_random_fnc(1) == 0)
                {
                    m_intrappos.m_x = x;
                    m_intrappos.m_y = y;
                    m_intrappos.m_EleType = m_OurLandscape->SupplyElementType(x, y);
                    m_intrappos.m_VegType = m_OurLandscape->SupplyVegType(x, y);
                    m_intrappos.m_inAtrap = true;
                    return;
                }
            }
        }
        for (int y = vy - (rad - 1); y <= vy + (rad - 1); y++)
        {
            int x = vx + rad;
            if (m_OurPopulation->IsTrap(x, y))
            {
                if (g_random_fnc(1) == 0)
                {
                    m_intrappos.m_x = x;
                    m_intrappos.m_y = y;
                    m_intrappos.m_EleType = m_OurLandscape->SupplyElementType(x, y);
                    m_intrappos.m_VegType = m_OurLandscape->SupplyVegType(x, y);
                    m_intrappos.m_inAtrap = true;
                    return;
                }
            }
            x = vx - rad;
            if (m_OurPopulation->IsTrap(x, y))
            {
                if (g_random_fnc(1) == 0)
                {
                    m_intrappos.m_x = x;
                    m_intrappos.m_y = y;
                    m_intrappos.m_EleType = m_OurLandscape->SupplyElementType(x, y);
                    m_intrappos.m_VegType = m_OurLandscape->SupplyVegType(x, y);
                    m_intrappos.m_inAtrap = true;
                    return;
                }
            }
        }
    }
}

References g_random_fnc(), Vole_Population_Manager::IsTrap(), AnimalPosition::m_EleType, InTrapPosition::m_inAtrap, m_intrappos, TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, m_OurPopulation, m_TerrRange, AnimalPosition::m_VegType, AnimalPosition::m_x, AnimalPosition::m_y, Landscape::SupplyElementType(), Landscape::SupplyVegType(), and Landscape::SupplyYearNumber().

Referenced by Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_JuvenileFemale::st_Evaluate_n_Explore(), and Vole_Female::st_Evaluate_n_Explore().

CopyMyself()

void Vole_Base::CopyMyself

(

VoleObject

a_vtype

)

Duplicates a vole.

Method used to duplicate a vole - most commonly used for experimental manipulation of populations e.g. return rate experiments

                                             {
    const auto av = new struct_Vole_Adult;
    av->VPM = m_OurPopulation;
    av->L = m_OurLandscape;
    av->m_flag = true; // Used to signal pesticide effect to CreateObjects
    av->PolyRefBorn = m_OurLandscape->SupplyPolyRef(m_Location_x, m_Location_y);
    av->ElemBorn = m_OurLandscape->SupplyElementType(av->PolyRefBorn);
    av->VegBorn = m_OurLandscape->SupplyVegType(m_Location_x, m_Location_y);
    av->x = (m_Location_x + 1) % m_OurPopulation->SupplySimW();
    av->y = m_Location_y % m_OurPopulation->SupplySimH();
    // Do the genetics
    av->Genes.Recombine(&m_MyGenes, &m_MyGenes);
    m_OurPopulation->CreateObjects(a_vtype, this, av, 1);
    // object will be destroyed by death state
    // but must let Dad know anyway
    delete av;
}

References Vole_Population_Manager::CreateObjects(), TAnimal::m_Location_x, TAnimal::m_Location_y, m_MyGenes, TAnimal::m_OurLandscape, m_OurPopulation, Landscape::SupplyElementType(), Landscape::SupplyPolyRef(), Population_Manager_Base::SupplySimH(), Population_Manager_Base::SupplySimW(), Landscape::SupplyVegType(), and struct_Vole_Adult::VPM.

Referenced by Vole_Population_Manager::Catastrophe().

DoWalking()

void Vole_Base::DoWalking ( int  p_Distance, int &  p_Vector, int &  vx, int &  vy  ) const

protected

Walking.

This method does the actual stepping - there is no look ahead here, so steps are taken one at a time based on the habitat type and vector given.

                                                                               {
    int t[5], q[5];
    t[0] = p_Vector;
    t[1] = p_Vector + 1 & 0x07;
    t[2] = p_Vector + 7 & 0x07;
    t[3] = p_Vector + 2 & 0x07;
    t[4] = p_Vector + 6 & 0x07;
    //*/
    for (int i = 0; i < p_Distance; i++)
    {
        // test the squares at Vector, Vector+1+2, Vector-1-2
        // They have either a quality or are inaccessible (water,buildings)
        // if can go to one of these squares then pick the best one
        // if all or some are equal then take a random pick.
        // if all are 'bad' then add or subtract one from vector and try again
 
        /*  t[0] = p_Vector;
            t[1] = (p_Vector+1) & 0x07;
            t[2] = (p_Vector+7) & 0x07;
            t[3] = (p_Vector+2) & 0x07;
            t[4] = (p_Vector+6) & 0x07; */
 
        q[0] = MoveQuality(vx + g_vector_x[t[0]], vy + g_vector_y[t[0]]);
        q[1] = MoveQuality(vx + g_vector_x[t[1]], vy + g_vector_y[t[1]]);
        q[2] = MoveQuality(vx + g_vector_x[t[2]], vy + g_vector_y[t[2]]);
        q[3] = MoveQuality(vx + g_vector_x[t[3]], vy + g_vector_y[t[3]]);
        q[4] = MoveQuality(vx + g_vector_x[t[4]], vy + g_vector_y[t[4]]);
        if (g_rand_uni_fnc() < MoveToLessFavourable)
        {
            // allow a mistake once in a while
            for (int j = 1; j < 5; j++) q[j] = -1;
        }
        // Now pick the best of these
        int best = q[0];
        int score = 1;
        for (int ii = 1; ii < 5; ii++)
        {
            if (q[ii] > best)
            {
                best = q[ii];
                score = 1;
            }
            else if (q[ii] == best) score++;
        }
        if (best == -1)
        {
            // can't go anywhere so change the vector
            if (g_random_fnc(2)) ++p_Vector;
            else --p_Vector;
            p_Vector &= 0x07;
            t[0] = p_Vector;
            t[1] = p_Vector + 1 & 0x07;
            t[2] = p_Vector + 7 & 0x07;
            t[3] = p_Vector + 2 & 0x07;
            t[4] = p_Vector + 6 & 0x07;
            //*/
        }
        else
        {
            // Can go to one of score squares
            const int scored = g_random_fnc(score); // pick one
            int loop = 0;
            for (int ii = 0; ii < 5; ii++)
            {
                if (best == q[ii]) loop++; // count the squares with 'best' quality
                if (loop > scored)
                {
                    loop = ii; // go to i-square
                    break;
                }
            }
            // change co-ordinates
            vx += g_vector_x[t[loop]];
            vy += g_vector_y[t[loop]];
        }
    }
}

References g_rand_uni_fnc(), g_random_fnc(), MoveQuality(), and MoveToLessFavourable.

Referenced by MoveTo().

DoWalkingCorrect()

void Vole_Base::DoWalkingCorrect ( int  p_Distance, int &  p_Vector, int &  vx, int &  vy  ) const

protected

Walking where there is a danger of stepping off the world.

This method does the actual stepping - there is no look ahead here, so steps are taken one at a time based on the habitat type and vector given.
This version corrects coords for wrap around. This is slower so is only called when necessary.

                                                                                      {
    int t[5], q[5];
    t[0] = p_Vector;
    t[1] = p_Vector + 1 & 0x07;
    t[2] = p_Vector + 7 & 0x07;
    t[3] = p_Vector + 2 & 0x07;
    t[4] = p_Vector + 6 & 0x07;
    //*/
    for (int i = 0; i < p_Distance; i++)
    {
        // test the squares at Vector, Vector+1+2, Vector-1-2
        // They have either a quality or are inaccessible (water,buildings)
        // if can go to one of these squares then pick the best one
        // if all or some are equal then take a random pick.
        // if all are 'bad' then add or subtract one from vector and try again
        /* t[0] = p_Vector;
         t[1] = (p_Vector+1) & 0x07;
         t[2] = (p_Vector+7) & 0x07;
         t[3] = (p_Vector+2) & 0x07;
         t[4] = (p_Vector+6) & 0x07; */
        q[0] = MoveQuality((vx + g_vector_x[t[0]]) % m_SimW, (vy + g_vector_y[t[0]]) % m_SimH);
        q[1] = MoveQuality((vx + g_vector_x[t[1]]) % m_SimW, (vy + g_vector_y[t[1]]) % m_SimH);
        q[2] = MoveQuality((vx + g_vector_x[t[2]]) % m_SimW, (vy + g_vector_y[t[2]]) % m_SimH);
        q[3] = MoveQuality((vx + g_vector_x[t[3]]) % m_SimW, (vy + g_vector_y[t[3]]) % m_SimH);
        q[4] = MoveQuality((vx + g_vector_x[t[4]]) % m_SimW, (vy + g_vector_y[t[4]]) % m_SimH);
        if (g_rand_uni_fnc() < MoveToLessFavourable)
        {
            // allow a mistake once in a while
            for (int j = 1; j < 5; j++) q[j] = -1;
        }
        // Now pick the best of these
        int best = q[0];
        int score = 1;
        for (int ii = 1; ii < 5; ii++)
        {
            if (q[ii] > best)
            {
                best = q[ii];
                score = 1;
            }
            else
                if (q[ii] == best) score++;
        }
        if (best == -1)
        {
            // can't go anywhere so change the vector
            if (g_random_fnc(2)) ++p_Vector;
            else --p_Vector;
            p_Vector &= 0x07;
            // /*
            t[0] = p_Vector;
            t[1] = p_Vector + 1 & 0x07;
            t[2] = p_Vector + 7 & 0x07;
            t[3] = p_Vector + 2 & 0x07;
            t[4] = p_Vector + 6 & 0x07; //*/
        }
        else
        {
            // Can go to one of score squares
            const int scored = g_random_fnc(score); // pick one
            int loop = 0;
            for (int ii = 0; ii < 5; ii++)
            {
                if (best == q[ii]) loop++; // count the squares with 'best' quality
                if (loop > scored)
                {
                    loop = ii; // go to i-square
                    break;
                }
            }
            // change co-ordinates
            vx += g_vector_x[t[loop]];
            vy += g_vector_y[t[loop]];
        }
    }
}

References g_rand_uni_fnc(), g_random_fnc(), m_SimH, m_SimW, MoveQuality(), and MoveToLessFavourable.

Referenced by MoveTo().

EndStep()

void Vole_Base::EndStep ( void  )

overridevirtual

All voles age at the end of the day.

Reimplemented from TALMaSSObject.

Reimplemented in Vole_JuvenileFemale, Vole_Male, and Vole_JuvenileMale.

                        {
    m_Age++; // Once a day increment m_Age
}

References m_Age.

Escape()

void Vole_Base::Escape ( int  p_Vector, int  p_Distance  )

protected

Dispersal - directed movement.

This works like MoveTo above, but with a rather more directed movement aimed at moving further from the start point.

                                                   {
    // This will alter m_Location_x & m_Location_y
    // it will give a very directed movement towards p_Vector
 
    // p_Vector gives the preferred direction (0-7)
    // p_Distance is the number of steps
    int vx = m_Location_x + m_SimW;
    int vy = m_Location_y + m_SimH;
    //    int counter = 0;
    for (int i = 0; i < p_Distance; i++)
    {
        // test the squares at Vector, Vector+1+2, Vector-1-2
        // They have either a quality or are inaccessible (water,buildings)
        // if can go to one of these squares then pick the best one
        // if all or some are equal then take a random pick.
        // if all are 'bad' then add or subtract one from p_Vector and try again
        //      counter ++;
        int t[3], q[3];
        t[0] = p_Vector;
        t[1] = p_Vector + 1 & 0x07;
        t[2] = p_Vector + 7 & 0x07;
        q[0] = MoveQuality((vx + g_vector_x[t[0]]) % m_SimW, (vy + g_vector_y[t[0]]) % m_SimH);
        q[1] = MoveQuality((vx + g_vector_x[t[1]]) % m_SimW, (vy + g_vector_y[t[1]]) % m_SimH);
        q[2] = MoveQuality((vx + g_vector_x[t[2]]) % m_SimW, (vy + g_vector_y[t[2]]) % m_SimH);
        // Now pick the best of these
        int noscore = 0;
        for (int ii = 0; ii < 3; ii++) { if (q[ii] == -1) { noscore++; } }
        if (noscore == 3)
        {
            // can't go anywhere so change the vector
            if (g_random_fnc(2)) p_Vector++;
            else p_Vector--;
        }
        else
        {
            // Can go to at least one of score squares
            // try the middle first
            int loop = 0;
            if (q[0] == -1)
            {
                // otherwise randomly try one side or other
                // it must be possible to go to one of these
                const int which = g_random_fnc(2);
                if (which == 1)
                {
                    if (q[1] != -1) loop = 1;
                    else loop = 2;
                }
                else
                {
                    if (q[2] != -1) loop = 2;
                    else loop = 1;
                }
            }
            // change co-ordinates
            vx += g_vector_x[t[loop]];
            vy += g_vector_y[t[loop]];
        }
    }
    // alter the voles location
    FreeLocation();
    m_Location_x = vx % m_SimW;
    m_Location_y = vy % m_SimH;
    m_OurPopulation->UpdateGuardMap(m_Location_x, m_Location_y, m_guard_cell_x, m_guard_cell_y);
    SetLocation();
}

References FreeLocation(), g_random_fnc(), TAnimal::m_guard_cell_x, TAnimal::m_guard_cell_y, TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulation, m_SimH, m_SimW, MoveQuality(), SetLocation(), and Population_Manager::UpdateGuardMap().

FreeLocation()

virtual void Vole_Base::FreeLocation ( )

inlineprotectedvirtual

Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.

                                {
    };

Referenced by Escape(), MoveTo(), and st_Dying().

GetDirectFlag()

int Vole_Base::GetDirectFlag ( )

inline

Genetic functionality

{ return m_MyGenes.GetDirectFlag(); }

References GeneticMaterial::GetDirectFlag(), and m_MyGenes.

GetFertile()

bool Vole_Base::GetFertile ( )

inline

Get the male vole fertility.

Primarily used in ecotoxicological simulations where toxic effects may render the vole sterile.

                      {
        return m_fertile;
    }

References m_fertile.

Referenced by Vole_Female::st_Mating().

GetGeneticFlag()

int Vole_Base::GetGeneticFlag ( )

inline

Genetic functionality

{ return m_MyGenes.GetGeneticFlag(); }

References GeneticMaterial::GetGeneticFlag(), and m_MyGenes.

GetLocation()

virtual bool Vole_Base::GetLocation ( int  , int    )

inlineprotectedvirtual

Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.

{ return false; };

Referenced by MoveTo().

Init()

void Vole_Base::Init ( struct_Vole_Adult *  a_AVoleStruct_ptr )

virtual

                                                         {
    m_Location_x = a_AVoleStruct_ptr->x;
    m_Location_y = a_AVoleStruct_ptr->y;
    m_OurLandscape = a_AVoleStruct_ptr->L;
    m_CurrentStateNo = 0;
    m_OurPopulation = a_AVoleStruct_ptr->VPM;
    m_Mature = false;
    m_Age = 0;
    m_Weight = 0.5;
    m_NoOfYoungTotal = 0;
    m_DispVector = -1;
    m_Have_Territory = false;
    m_TerrRange = 0; // The size of the territory
    m_MinTerrRange = 0;
    m_Reserves = 3;
    m_LifeSpan = 365 + 60 + static_cast<int>(g_rand_uni_fnc() * (30 * cfg_vole_LifeMonths.value())); //
    CurrentVState = tovs_InitialState;
    m_intrappos.m_inAtrap = false;
    m_BornLastYear = false;
 
    m_MyGenes = a_AVoleStruct_ptr->Genes;
    m_SimH = m_OurPopulation->SupplySimH();
    m_SimW = m_OurPopulation->SupplySimW();
    IDNo = m_OurPopulation->IDNumber++;
 
    const unsigned FatherIdNo = a_AVoleStruct_ptr->FatherId;
    Set_FatherId(FatherIdNo);
    const unsigned MotherIdNo = a_AVoleStruct_ptr->MotherId;
    Set_MotherId(MotherIdNo);
    Set_XBorn(m_Location_x);
    Set_YBorn(m_Location_y);
    Set_PolyRefBorn(m_Location_x, m_Location_y);
    Set_VegBorn(m_Location_x, m_Location_y);
    Set_ElemBorn(m_Location_x, m_Location_y);
    Set_BirthYear(a_AVoleStruct_ptr->BirthYear);
 
    m_MinMaleTerritorySize = cfg_MinMaleTerritorySize.value();
    m_MaxMaleTerritorySize = cfg_MaxMaleTerrSize.value();
    if (m_MaxMaleTerritorySize < m_MinMaleTerritorySize) m_MaxMaleTerritorySize = m_MinMaleTerritorySize; // Corrects a bug caused by incorrect input settings
    m_MinFemaleTerritorySize = cfg_MinFemaleTerritorySize.value();
    m_MaxFemaleTerritorySize = cfg_MaxFemaleTerrSize.value();
    if (m_MaxFemaleTerritorySize < m_MinFemaleTerritorySize) m_MaxFemaleTerritorySize = m_MinFemaleTerritorySize; // Corrects a bug caused by incorrect input settings
    m_MinFVoleHabQual = cfg_vole_habqualscaler.value() * (4 * m_MinFemaleTerritorySize * m_MinFemaleTerritorySize);
    m_MinMVoleHabQual = cfg_vole_habqualscaler.value() * (4 * m_MinMaleTerritorySize * m_MinMaleTerritorySize);
    m_MinJMVoleHabQual = cfg_vole_habqualscaler.value() * (4 * m_MinFemaleTerritorySize * m_MinFemaleTerritorySize); // Yes this should be female
    m_MaleTerritoryRangeSlope = (m_MaxMaleTerritorySize - m_MinMaleTerritorySize) / (MaxWeightM - MinReproWeightM);
    m_FemaleTerritoryRangeSlope = (m_MaxFemaleTerritorySize - m_MinFemaleTerritorySize) / (MaxWeightF - MinReproWeightF);
#ifdef __VoleStarvationDays
        m_StarvationDays = 0;
        m_MaxStarvationDays = cfg_MaxStarvationDays.value();
#endif
#ifdef __VOLEPESTICIDEON
        ClearPesticidLoad();
        m_pesticideBioDegradeRate = cfg_volepcidebiodegredrate.value();
        SetPesticideInfluenced1(false);
        SetPesticideInfluenced2(false);
        m_pesticideInfluenced3 = 0.0;
#endif
    m_fertile = true;
}

References struct_Vole_Adult::BirthYear, cfg_MaxFemaleTerrSize, cfg_MaxMaleTerrSize, cfg_MaxStarvationDays, cfg_MinFemaleTerritorySize, cfg_MinMaleTerritorySize, cfg_vole_habqualscaler, cfg_vole_LifeMonths, cfg_volepcidebiodegredrate, CurrentVState, struct_Vole_Adult::FatherId, g_rand_uni_fnc(), struct_Vole_Adult::Genes, IDNo, Vole_Population_Manager::IDNumber, struct_Vole_Adult::L, m_Age, m_BornLastYear, TALMaSSObject::m_CurrentStateNo, m_DispVector, m_FemaleTerritoryRangeSlope, m_fertile, m_Have_Territory, InTrapPosition::m_inAtrap, m_intrappos, m_LifeSpan, TAnimal::m_Location_x, TAnimal::m_Location_y, m_MaleTerritoryRangeSlope, m_Mature, m_MaxFemaleTerritorySize, m_MaxMaleTerritorySize, m_MinFemaleTerritorySize, m_MinFVoleHabQual, m_MinJMVoleHabQual, m_MinMaleTerritorySize, m_MinMVoleHabQual, m_MinTerrRange, m_MyGenes, m_NoOfYoungTotal, TAnimal::m_OurLandscape, m_OurPopulation, m_Reserves, m_SimH, m_SimW, m_TerrRange, m_Weight, MaxWeightF, MaxWeightM, MinReproWeightF, MinReproWeightM, struct_Vole_Adult::MotherId, Set_BirthYear(), Set_ElemBorn(), Set_FatherId(), Set_MotherId(), Set_PolyRefBorn(), Set_VegBorn(), Set_XBorn(), Set_YBorn(), Population_Manager_Base::SupplySimH(), Population_Manager_Base::SupplySimW(), tovs_InitialState, CfgInt::value(), CfgFloat::value(), struct_Vole_Adult::VPM, struct_Vole_Adult::x, and struct_Vole_Adult::y.

Referenced by ReInit(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), and Vole_Base().

MortalityTest()

bool Vole_Base::MortalityTest ( )

virtual

Do a mortality test.

Takes both physiological lifespan and background mortality into account to determine whether the vole should die - repeated calls increase the risk of dying

Reimplemented in Vole_Male.

                              {
    // returns true if the vole should die
    if (g_rand_uni_fnc() < g_DailyMortChance) { return true; }
    // returns true if the vole should die
    return false;
}

References g_DailyMortChance, and g_rand_uni_fnc().

Referenced by Vole_JuvenileMale::BeginStep(), and Vole_JuvenileFemale::BeginStep().

MoveQuality()

int Vole_Base::MoveQuality ( int  p_x, int  p_y  ) const

protected

Test a location for quality while moving.

Returns the quality of a patch of habitat at p_x,p_y.
Can't walk through another vole though - so test location first.

                                                 {
    if (m_OurPopulation->m_VoleMap->GetMapValue(p_x, p_y) != nullptr)
        return -1;
    // Nobody there so carry on
 
    return vole_tole_move_quality(m_OurLandscape, p_x, p_y);
}

References IDMap< a_type >::GetMapValue(), TAnimal::m_OurLandscape, m_OurPopulation, Vole_Population_Manager::m_VoleMap, and vole_tole_move_quality().

Referenced by DoWalking(), DoWalkingCorrect(), Escape(), and Vole_Male::st_Eval_n_Explore().

MoveTo()

void Vole_Base::MoveTo ( int  p_Vector, int  p_Distance, int  p_iterations  )

protected

Movement.

Do an assessment of the quality of the voles territory, and move. This function does the same as the other CalcuateCarryingCapacity except that it alters the two values stand_x, stand_y to set them to be in the best polygon in the territory

Returns the mean of the qualities in the area covered by the territory (even if the vole does not have one)

Uses the algorithm for fast searching of square arrays with wrap around co-ordinates.
parameters = x,y starting coordinates top left
range = extent of the space to search
bottom left coordinate is therefore x+range, y+range
22/09/2000

For each polygon it gets the quality and multiplies by area of that polygon in the territory. This is summed for all polygons in the territory to get overall quality. This will alter m_Location_x & m_Location_y.
It will give a rather directed movement towards p_Vector.
Generally the vole will stay in the best habitat, but occasional mis-steps occur.
p_Vector gives the preferred direction (0-7), p_Distance is the number of steps.

                                                                     {
    const int offset = p_Distance * p_iterations;
    if (m_Location_x - offset < 0 || m_Location_x + offset >= m_SimW || m_Location_y - offset < 0 || m_Location_y + offset >= m_SimH)
    {
        // Need correct coords
        // Make sure that the coords can't become -ve
        int vx = m_Location_x + m_SimW;
        int vy = m_Location_y + m_SimH;
        do
        {
            DoWalkingCorrect(p_Distance, p_Vector, vx, vy);
            p_Distance = 1;
        }
        while (GetLocation(vx % m_SimW, vy % m_SimH) && p_iterations-- > 0);
        // alter the voles location (& correct coords)
        FreeLocation();
        m_Location_x = vx % m_SimW;
        m_Location_y = vy % m_SimH;
        m_OurPopulation->UpdateGuardMap(m_Location_x, m_Location_y, m_guard_cell_x, m_guard_cell_y);
        SetLocation();
    }
    else
    {
        // Don't need correct coords
        int vx = m_Location_x;
        int vy = m_Location_y;
        do
        {
            DoWalking(p_Distance, p_Vector, vx, vy);
            p_Distance = 1;
        }
        while (GetLocation(vx, vy) && p_iterations-- > 0);
        // alter the voles location (& correct coords)
        FreeLocation();
        m_Location_x = vx;
        m_Location_y = vy;
        m_OurPopulation->UpdateGuardMap(m_Location_x, m_Location_y, m_guard_cell_x, m_guard_cell_y);
        SetLocation();
    }
}

References DoWalking(), DoWalkingCorrect(), FreeLocation(), GetLocation(), TAnimal::m_guard_cell_x, TAnimal::m_guard_cell_y, TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulation, m_SimH, m_SimW, SetLocation(), and Population_Manager::UpdateGuardMap().

Referenced by Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_JuvenileMale::st_JuvenileExplore(), and Vole_Female::st_Special_Explore().

OnKilled()

virtual void Vole_Base::OnKilled ( )

inlinevirtual

Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.

                            {
    };

ReInit()

void Vole_Base::ReInit ( struct_Vole_Adult *  a_AVoleStruct_ptr )

virtual

Reimplemented in Vole_Female, Vole_JuvenileFemale, Vole_Male, and Vole_JuvenileMale.

{ Init(a_AVoleStruct_ptr); }

References Init().

RodenticideIngestion()

void Vole_Base::RodenticideIngestion ( void  )

protectedvirtual

                                         {
    const double rodenticide = m_OurLandscape->SupplyRodenticide(m_Location_x, m_Location_y);
    if (rodenticide > 0)
    {
        // Todo effects
    }
    else return;
}

References TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, and Landscape::SupplyRodenticide().

Set_Age()

void Vole_Base::Set_Age ( int  Age )

inline

Set our age

{ m_Age = Age; }

References m_Age.

Set_BirthYear()

void Vole_Base::Set_BirthYear ( int  BirthYear )

inline

Set year of birth

{ m_BirthYear = BirthYear; }

References m_BirthYear.

Referenced by Init().

Set_ElemBorn()

void Vole_Base::Set_ElemBorn ( int  a_Location_x, int  a_Location_y  )

inline

Set element type of birth location

    {
        TTypesOfLandscapeElement const m_EBorn = m_OurLandscape->SupplyElementType(a_Location_x, a_Location_y);
        m_ElemBorn = m_OurLandscape->BackTranslateEleTypes(m_EBorn);
    }

References Landscape::BackTranslateEleTypes(), m_ElemBorn, TAnimal::m_OurLandscape, and Landscape::SupplyElementType().

Referenced by Init().

Set_FatherId()

void Vole_Base::Set_FatherId ( unsigned  FatherIdNo )

inline

Set father ID

{ m_FatherId = FatherIdNo; }; // ***TD***

References m_FatherId.

Referenced by Init().

Set_MotherId()

void Vole_Base::Set_MotherId ( unsigned  MotherIdNo )

inline

Set mother ID

{ m_MotherId = MotherIdNo; }; // ***TD***

References m_MotherId.

Referenced by Init().

Set_NoYoungTot()

void Vole_Base::Set_NoYoungTot ( int  a_NoOfYoung )

inline

Sets the number of young produced by the female

{ m_NoOfYoungTotal += a_NoOfYoung; }; // ***TD***

References m_NoOfYoungTotal.

Set_PolyRefBorn()

void Vole_Base::Set_PolyRefBorn ( int  a_Location_x, int  a_Location_y  )

inline

Set polygonref of birth location

{ m_PolyRefBorn = (m_OurLandscape->SupplyPolyRef(a_Location_x, a_Location_y)); }; // ***TD***

References TAnimal::m_OurLandscape, m_PolyRefBorn, and Landscape::SupplyPolyRef().

Referenced by Init().

Set_VegBorn()

void Vole_Base::Set_VegBorn ( int  a_Location_x, int  a_Location_y  )

inline

Set vegetation type of birth location

    {
        TTypesOfVegetation const m_VBorn = (m_OurLandscape->SupplyVegType(a_Location_x, a_Location_y));
        m_VegBorn = (m_OurLandscape->BackTranslateVegTypes(m_VBorn));
    }

References Landscape::BackTranslateVegTypes(), TAnimal::m_OurLandscape, m_VegBorn, and Landscape::SupplyVegType().

Referenced by Init().

Set_XBorn()

void Vole_Base::Set_XBorn ( int  a_Location_x )

inline

Set x-coordinate of birth location

{ m_XBorn = a_Location_x; }; // ***TD***

References m_XBorn.

Referenced by Init().

Set_YBorn()

void Vole_Base::Set_YBorn ( int  a_Location_y )

inline

Set y-coordinate of birth location

{ m_YBorn = a_Location_y; }; // ***TD***

References m_YBorn.

Referenced by Init().

SetBreedingSeason()

void Vole_Base::SetBreedingSeason ( bool  a_flag )

inline

Set Breeding Season flag.

{ m_BreedingSeason = a_flag; }

References m_BreedingSeason.

SetDirectFlag()

void Vole_Base::SetDirectFlag ( )

inline

Genetic functionality

{ m_MyGenes.SetDirectFlag(); }

References m_MyGenes, and GeneticMaterial::SetDirectFlag().

SetFertile()

void Vole_Base::SetFertile ( bool  f )

inline

Set the male vole fertility.

Primarily used in ecotoxicological simulations where toxic effects may render the vole sterile.

                            {
        m_fertile = f;
    }

References m_fertile.

SetFree()

void Vole_Base::SetFree ( )

inline

Release vole from trap

{ m_intrappos.m_inAtrap = false; }

References InTrapPosition::m_inAtrap, and m_intrappos.

SetGeneticFlag()

void Vole_Base::SetGeneticFlag ( )

inline

Genetic functionality

{ m_MyGenes.SetGeneticFlag(); }

References m_MyGenes, and GeneticMaterial::SetGeneticFlag().

SetLocation()

virtual void Vole_Base::SetLocation ( )

inlineprotectedvirtual

Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.

                               {
    };

Referenced by Escape(), and MoveTo().

Setm_Mature()

void Vole_Base::Setm_Mature ( )

inline

Become adult

{ m_Mature = true; }

References m_Mature.

Referenced by Vole_Female::st_BecomeReproductive(), Vole_Male::st_Eval_n_Explore(), and Vole_Male::Step().

SetWeight()

void Vole_Base::SetWeight ( double  W )

inline

Set our weight

{ m_Weight = W; }

References m_Weight.

st_Dying()

void Vole_Base::st_Dying

(

void

)

All voles end here on death.

Called when a vole dies. Just removes itself from the map and sets a flag to destroy the object in the endStep

                         {
    FreeLocation();
    m_CurrentStateNo = -1;
}

References FreeLocation(), and TALMaSSObject::m_CurrentStateNo.

Referenced by Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), and Vole_JuvenileFemale::EndStep().

Step()

void Vole_Base::Step ( void  )

inlineoverridevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Vole_Female, Vole_JuvenileFemale, Vole_Male, and Vole_JuvenileMale.

                         {
    };

SupplyAge()

unsigned Vole_Base::SupplyAge ( )

inline

Tell our age

{ return m_Age; };

References m_Age.

Referenced by Vole_Population_Manager::SupplyInOlderTerr(), Vole_Population_Manager::SupplyOlderFemales(), and Vole_Population_Manager::TheAgeSexLocationProbe().

SupplyAllele()

int Vole_Base::SupplyAllele ( int  locus, int  allele  )

inline

Genetic functionality

{ return m_MyGenes.GetAllele(locus, allele); }

References GeneticMaterial::GetAllele(), and m_MyGenes.

SupplyBirthYear()

int Vole_Base::SupplyBirthYear ( )

inline

Tell our birth year

{ return m_BirthYear; }; // ***TD***

References m_BirthYear.

SupplyBornLastYear()

bool Vole_Base::SupplyBornLastYear ( )

inline

Were we born this year?

{ return m_BornLastYear; }

References m_BornLastYear.

SupplyDeathCause()

int Vole_Base::SupplyDeathCause ( )

inline

Tell the cause of death

{ return m_Death; }; // ***TD***

References m_Death.

SupplyElemBorn()

int Vole_Base::SupplyElemBorn ( )

inline

Tell our elementype at birth location

{ return m_ElemBorn; }; // ***TD***

References m_ElemBorn.

SupplyElemType()

TTypesOfLandscapeElement Vole_Base::SupplyElemType ( )

inline

Provide our current elementype

{ return m_OurLandscape->SupplyElementType(m_Location_x, m_Location_y); };

References TAnimal::m_Location_x, TAnimal::m_Location_y, TAnimal::m_OurLandscape, and Landscape::SupplyElementType().

SupplyFatherId()

int Vole_Base::SupplyFatherId ( )

inline

Tell father ID

{ return m_FatherId; }; // ***TD***

References m_FatherId.

SupplyGenes()

GeneticMaterial Vole_Base::SupplyGenes ( )

inline

Genetic functionality

{ return m_MyGenes; }

References m_MyGenes.

Referenced by Vole_Female::st_Mating().

SupplyHeteroZyg()

int Vole_Base::SupplyHeteroZyg ( )

inline

Genetic functionality

{ return m_MyGenes.HeterozygosityCount(); }

References GeneticMaterial::HeterozygosityCount(), and m_MyGenes.

SupplyHomoZyg()

int Vole_Base::SupplyHomoZyg ( )

inline

Genetic functionality

{ return m_MyGenes.HomozygosityCount(); }

References GeneticMaterial::HomozygosityCount(), and m_MyGenes.

SupplyIDNo()

int Vole_Base::SupplyIDNo ( )

inline

Tell our ID number

{ return IDNo; }; // ***TD***

References IDNo.

Referenced by Vole_Female::st_Lactating(), and Vole_Female::st_Mating().

SupplyInTrap()

bool Vole_Base::SupplyInTrap ( )

inline

Are we in a trap?

{ return m_intrappos.m_inAtrap; }

References InTrapPosition::m_inAtrap, and m_intrappos.

SupplyMature()

bool Vole_Base::SupplyMature ( )

inline

Tell if mature

{ return m_Mature; };

References m_Mature.

SupplyMotherId()

int Vole_Base::SupplyMotherId ( )

inline

Tell mother ID

{ return m_MotherId; }; // ***TD***

References m_MotherId.

SupplyMyAllele()

uint32 Vole_Base::SupplyMyAllele ( int  i, int  j  )

inline

{ return m_MyGenes.GetAllele(i, j); } //*TD

References GeneticMaterial::GetAllele(), and m_MyGenes.

SupplyPolyRefBorn()

int Vole_Base::SupplyPolyRefBorn ( )

inline

Tell our polygon ref at birth location

{ return m_PolyRefBorn; }; // ***TD***

References m_PolyRefBorn.

SupplySex()

bool Vole_Base::SupplySex ( )

inline

Tell our sex

{ return m_Sex; };

References m_Sex.

Referenced by Vole_Population_Manager::FindClosestFemale(), Vole_Population_Manager::FindClosestMale(), Vole_Population_Manager::FindWithinRadiusMale(), Vole_Population_Manager::ListClosestFemales(), Vole_Population_Manager::ListClosestMales(), Vole_Population_Manager::SupplyCountFemales(), Vole_Population_Manager::SupplyInOlderTerr(), and Vole_Population_Manager::SupplyOlderFemales().

SupplyTerritorial()

bool Vole_Base::SupplyTerritorial ( )

inline

Tell whether we have a territory

{ return m_Have_Territory; } // ***TD***

References m_Have_Territory.

Referenced by Vole_Population_Manager::FindClosestFemale(), Vole_Population_Manager::FindClosestMale(), Vole_Population_Manager::FindOutsideRadiusMale(), Vole_Population_Manager::FindWithinRadiusMale(), Vole_Population_Manager::ListClosestFemales(), Vole_Population_Manager::ListClosestMales(), Vole_Population_Manager::SupplyCountFemales(), and Vole_Population_Manager::SupplyInOlderTerr().

SupplyTerrRange()

int Vole_Base::SupplyTerrRange ( )

inline

Tell our territory range

{ return m_TerrRange; }; // ***TD***

References m_TerrRange.

SupplyTotNoYoung()

int Vole_Base::SupplyTotNoYoung ( )

inline

Tell our number of young produced

{ return m_NoOfYoungTotal; }; // ***TD***

References m_NoOfYoungTotal.

SupplyTrapPosition()

InTrapPosition Vole_Base::SupplyTrapPosition ( )

inline

Get the trap location

{ return m_intrappos; }

References m_intrappos.

SupplyVegBorn()

int Vole_Base::SupplyVegBorn ( )

inline

Tell our vegetation type at birth location

{ return m_VegBorn; }; // ***TD***

References m_VegBorn.

SupplyWeight()

double Vole_Base::SupplyWeight ( )

inline

Tell our weight

{ return m_Weight; };

References m_Weight.

SupplyX()

unsigned Vole_Base::SupplyX ( )

inline

Tell our x coordinate

{ return m_Location_x; };

References TAnimal::m_Location_x.

SupplyXBorn()

int Vole_Base::SupplyXBorn ( )

inline

Tell our x-coordinate at birth

{ return m_XBorn; }; // ***TD***

References m_XBorn.

SupplyY()

unsigned Vole_Base::SupplyY ( )

inline

Tell our y coordinate

{ return m_Location_y; };

References TAnimal::m_Location_y.

SupplyYBorn()

int Vole_Base::SupplyYBorn ( )

inline

Tell our x-coordinate at birth

{ return m_YBorn; }; // ***TD***

References m_YBorn.

UnsetDirectFlag()

void Vole_Base::UnsetDirectFlag ( )

inline

Genetic functionality

{ m_MyGenes.UnsetDirectFlag(); }

References m_MyGenes, and GeneticMaterial::UnsetDirectFlag().

UnsetGeneticFlag()

void Vole_Base::UnsetGeneticFlag ( )

inline

Genetic functionality

{ m_MyGenes.UnsetGeneticFlag(); }

References m_MyGenes, and GeneticMaterial::UnsetGeneticFlag().

WhatState()

int Vole_Base::WhatState ( )

inlineoverridevirtual

Get our current vole state

Reimplemented from TAnimal.

{ return CurrentVState; }

References CurrentVState.

Member Data Documentation

CurrentVState

TTypeOfVoleState Vole_Base::CurrentVState

Our current behavioural state

Referenced by Vole_JuvenileMale::BeginStep(), Vole_JuvenileFemale::BeginStep(), Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileMale::OnFarmEvent(), Vole_JuvenileFemale::OnFarmEvent(), Vole_JuvenileMale::OnKilled(), Vole_JuvenileFemale::OnKilled(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_Male::st_Eval_n_Explore(), Vole_JuvenileMale::Step(), Vole_Male::Step(), Vole_JuvenileFemale::Step(), Vole_Female::Step(), and WhatState().

IDNo

unsigned Vole_Base::IDNo

protected

Their individual ID number

Referenced by Init(), and SupplyIDNo().

m_Age

int Vole_Base::m_Age

protected

Their age in days

Referenced by Vole_Male::Dispersal(), EndStep(), Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), Set_Age(), Vole_Female::st_BecomeReproductive(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_Special_Explore(), Vole_JuvenileFemale::Step(), SupplyAge(), Vole_Female::Vole_Female(), Vole_JuvenileFemale::Vole_JuvenileFemale(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_BirthYear

int Vole_Base::m_BirthYear

protected

The year of birth

Referenced by Vole_Male::ReInit(), Set_BirthYear(), SupplyBirthYear(), and Vole_Male::Vole_Male().

m_BornLastYear

bool Vole_Base::m_BornLastYear

protected

A flag set if the female was born the year before.

Referenced by Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileFemale::ReInit(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_GiveBirth(), SupplyBornLastYear(), and Vole_JuvenileFemale::Vole_JuvenileFemale().

m_BreedingSeason

bool Vole_Base::m_BreedingSeason = false

staticprotected

Local storage for whether it is breeding season

Referenced by Vole_Male::Dispersal(), SetBreedingSeason(), Vole_Female::st_BecomeReproductive(), Vole_Male::st_Eval_n_Explore(), and Vole_Female::st_Mating().

m_Death

int Vole_Base::m_Death

protected

Death course

Referenced by SupplyDeathCause().

m_DispVector

int Vole_Base::m_DispVector

protected

The current dispersal direction

Referenced by Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Init(), Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_JuvenileFemale::st_Evaluate_n_Explore(), and Vole_Female::st_Evaluate_n_Explore().

m_ElemBorn

int Vole_Base::m_ElemBorn

protected

The element type at at birth location

Referenced by Set_ElemBorn(), and SupplyElemBorn().

m_FatherId

unsigned Vole_Base::m_FatherId

protected

The id number of the fater

Referenced by Set_FatherId(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), and SupplyFatherId().

m_FemaleTerritoryRangeSlope

double Vole_Base::m_FemaleTerritoryRangeSlope = 0

staticprotected

only used to create an increasing territory size with age

Referenced by Vole_JuvenileFemale::EndStep(), and Init().

m_fertile

bool Vole_Base::m_fertile

protected

Flag indicating the fertility state (true means fertile)

Referenced by GetFertile(), Init(), and SetFertile().

m_FHabQualThreshold1

double Vole_Base::m_FHabQualThreshold1

staticprotected

Habitat is v.bad below this

m_FHabQualThreshold2

double Vole_Base::m_FHabQualThreshold2

staticprotected

Habitat is OK above this

m_FHabQualThreshold3

double Vole_Base::m_FHabQualThreshold3

staticprotected

Habitat is v.good above this

m_Have_Territory

bool Vole_Base::m_Have_Territory

protected

Do they have a terriory?

Referenced by Vole_Male::Dispersal(), Vole_Male::EndStep(), Init(), Vole_Male::MortalityTest(), Vole_Female::st_BecomeReproductive(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_Evaluate_n_Explore(), Vole_Female::st_GiveBirth(), Vole_Female::st_Special_Explore(), and SupplyTerritorial().

m_intrappos

InTrapPosition Vole_Base::m_intrappos

protected

Referenced by CheckTraps(), Init(), SetFree(), SupplyInTrap(), and SupplyTrapPosition().

m_LifeSpan

int Vole_Base::m_LifeSpan

protected

Their lifespan remaining (unless killed by external events)

Referenced by Vole_JuvenileMale::BeginStep(), Vole_JuvenileFemale::BeginStep(), and Init().

m_MaleTerritoryRangeSlope

double Vole_Base::m_MaleTerritoryRangeSlope = 0

staticprotected

only used to create an increasing territory size with age

Referenced by Vole_Male::DetermineTerritorySize(), and Init().

m_Mature

bool Vole_Base::m_Mature

protected

Whether they are mature or not

Referenced by Vole_Male::Dispersal(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Init(), Setm_Mature(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_ReproBehaviour(), Vole_Female::st_Special_Explore(), and SupplyMature().

m_MaxFemaleTerritorySize

unsigned int Vole_Base::m_MaxFemaleTerritorySize = 0

staticprotected

Maximum territory size female

Referenced by Init().

m_MaxMaleTerritorySize

unsigned int Vole_Base::m_MaxMaleTerritorySize = 0

staticprotected

Maximum territory size male

Referenced by Init(), and Vole_Female::st_Mating().

m_MHabQualThreshold1

double Vole_Base::m_MHabQualThreshold1

staticprotected

Habitat is v.bad below this

m_MHabQualThreshold2

double Vole_Base::m_MHabQualThreshold2

staticprotected

Habitat is OK above this

m_MHabQualThreshold3

double Vole_Base::m_MHabQualThreshold3

staticprotected

Habitat is v.good above this

m_MinFemaleTerritorySize

unsigned int Vole_Base::m_MinFemaleTerritorySize = 0

staticprotected

Minimum territory size female

Referenced by Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), Vole_Female::Vole_Female(), and Vole_JuvenileFemale::Vole_JuvenileFemale().

m_MinFVoleHabQual

double Vole_Base::m_MinFVoleHabQual = 0

staticprotected

Minimum acceptable habitat quality - assumes that minimum hab qual for survival is 2 * min female terr size

Referenced by Init(), Vole_Male::st_Eval_n_Explore(), Vole_JuvenileFemale::st_Evaluate_n_Explore(), and Vole_Female::st_Evaluate_n_Explore().

m_MinJMVoleHabQual

double Vole_Base::m_MinJMVoleHabQual = 0

staticprotected

Minimum acceptable habitat juvenile male quality - assumes that minimum hab qual for survival is 2 * min male terr size

Referenced by Init(), and Vole_JuvenileMale::st_Eval_n_Explore().

m_MinMaleTerritorySize

unsigned int Vole_Base::m_MinMaleTerritorySize = 0

staticprotected

Minimum territory size male

Referenced by Vole_Male::DetermineTerritorySize(), Init(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_MinMVoleHabQual

double Vole_Base::m_MinMVoleHabQual = 0

staticprotected

Minimum acceptable habitat quality - assumes that minimum hab qual for survival is 2 * min female terr size

Referenced by Vole_Male::CanFeed(), Vole_Male::Dispersal(), and Init().

m_MinTerrRange

unsigned int Vole_Base::m_MinTerrRange

protected

The minimum territory range

Referenced by CalculateCarryingCapacity(), Init(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), Vole_Male::st_Infanticide(), Vole_Female::Vole_Female(), Vole_JuvenileFemale::Vole_JuvenileFemale(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_MotherId

unsigned Vole_Base::m_MotherId

protected

The id number of the mother

Referenced by Set_MotherId(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), and SupplyMotherId().

m_MyGenes

GeneticMaterial Vole_Base::m_MyGenes

protected

Their genes

Referenced by CopyMyself(), GetDirectFlag(), GetGeneticFlag(), Init(), SetDirectFlag(), SetGeneticFlag(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_Female::st_Lactating(), SupplyAllele(), SupplyGenes(), SupplyHeteroZyg(), SupplyHomoZyg(), SupplyMyAllele(), UnsetDirectFlag(), and UnsetGeneticFlag().

m_NoOfYoungTotal

int Vole_Base::m_NoOfYoungTotal

protected

Referenced by Init(), Set_NoYoungTot(), Vole_Female::st_GiveBirth(), and SupplyTotNoYoung().

m_OurPopulation

Vole_Population_Manager* Vole_Base::m_OurPopulation

Referenced by Vole_JuvenileMale::BeginStep(), Vole_JuvenileFemale::BeginStep(), CalculateCarryingCapacity(), CheckTraps(), CopyMyself(), Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Escape(), Vole_JuvenileMale::FreeLocation(), Vole_JuvenileFemale::FreeLocation(), Vole_JuvenileMale::GetLocation(), Vole_JuvenileFemale::GetLocation(), Init(), MoveQuality(), MoveTo(), Vole_JuvenileMale::OnFarmEvent(), Vole_JuvenileFemale::OnFarmEvent(), Vole_Female::OnInfanticideAttempt(), Vole_JuvenileMale::OnKilled(), Vole_JuvenileFemale::OnKilled(), Vole_JuvenileMale::SetLocation(), Vole_JuvenileFemale::SetLocation(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_GiveBirth(), Vole_Male::st_Infanticide(), Vole_Female::st_Lactating(), Vole_Female::st_Mating(), Vole_Male::st_Maturation(), Vole_Female::st_Special_Explore(), Vole_JuvenileFemale::Step(), and Vole_Female::Step().

m_PolyRefBorn

int Vole_Base::m_PolyRefBorn

protected

Their polygon ref at birth location

Referenced by Set_PolyRefBorn(), and SupplyPolyRefBorn().

m_Reserves

int Vole_Base::m_Reserves

protected

Their reserves - in days that they can survive without food

Referenced by Init(), and Vole_Female::st_Lactating().

m_Sex

bool Vole_Base::m_Sex

protected

Their sex Male==true Female==false

Referenced by Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), SupplySex(), Vole_JuvenileFemale::Vole_JuvenileFemale(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_SimH

int Vole_Base::m_SimH

protected

The size of simulation landscape

Referenced by CalculateCarryingCapacity(), DoWalkingCorrect(), Escape(), Init(), MoveTo(), and Vole_Male::st_Eval_n_Explore().

m_SimW

int Vole_Base::m_SimW

protected

Referenced by CalculateCarryingCapacity(), DoWalkingCorrect(), Escape(), Init(), MoveTo(), and Vole_Male::st_Eval_n_Explore().

m_TerrRange

int Vole_Base::m_TerrRange

protected

The size of their territory (radius of a square)

Referenced by CalculateCarryingCapacity(), CheckTraps(), Vole_Male::DetermineTerritorySize(), Vole_Male::Dispersal(), Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), Vole_JuvenileMale::st_Eval_n_Explore(), Vole_Male::st_Eval_n_Explore(), Vole_Female::st_Special_Explore(), SupplyTerrRange(), Vole_Female::Vole_Female(), Vole_JuvenileFemale::Vole_JuvenileFemale(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_VegBorn

int Vole_Base::m_VegBorn

protected

The vegetation type at birth location

Referenced by Set_VegBorn(), and SupplyVegBorn().

m_Weight

double Vole_Base::m_Weight

protected

Their weight in grams

Referenced by Vole_Male::DetermineTerritorySize(), Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Init(), Vole_JuvenileMale::ReInit(), Vole_Male::ReInit(), Vole_JuvenileFemale::ReInit(), Vole_Female::ReInit(), SetWeight(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_Male::st_Infanticide(), SupplyWeight(), Vole_Female::Vole_Female(), Vole_JuvenileFemale::Vole_JuvenileFemale(), Vole_JuvenileMale::Vole_JuvenileMale(), and Vole_Male::Vole_Male().

m_XBorn

int Vole_Base::m_XBorn

protected

Their x location at birth

Referenced by Set_XBorn(), and SupplyXBorn().

m_YBorn

int Vole_Base::m_YBorn

protected

Their y location at birth

Referenced by Set_YBorn(), and SupplyYBorn().

---

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

• /builds/ALMaSS/ALMaSS_MIDox/Vole/vole_all.h
• /builds/ALMaSS/ALMaSS_MIDox/Vole/Vole_all.cpp