ALMaSS: TPredator Class Reference

•All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

The base class for predators encompsassing all their general behaviours. More...

#include <Predators.h>

Inheritance diagram for TPredator:

Public Member Functions
	TPredator (Vole_Population_Manager ThePrey, int p_x, int p_y, Landscape p_L, TPredator_Population_Manager *p_PPM)

	~TPredator ()

bool	OverlapMyTerritory (unsigned x, unsigned y)

virtual void	st_Dispersal ()

virtual void	st_Movement ()

virtual int	st_Hunting ()

virtual void	BeginStep (void)
	BeingStep behaviour - must be implemented in descendent classes. More...

virtual void	Step (void)
	Step behaviour - must be implemented in descendent classes. More...

virtual void	EndStep (void)
	EndStep behaviour - must be implemented in descendent classes. More...

unsigned	SupplySpeciesID ()

int	SupplyKill ()

bool	SupplyTerr ()

int	SupplyKillEff ()

int	SupplyHomeRange ()

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...

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...

Protected Attributes
TTypeOfPredatorState	CurrentPState

unsigned	SpeciesID

unsigned	m_DispersalMax

unsigned	m_SearchArea

int	m_kills_this_season

int	PreyResponse1

int	PreyResponse2

int	m_Search_x

int	m_Search_y

int	SimW

int	SimH

unsigned	m_FailureCount

unsigned	m_NoFailuresBeforeDispersal

unsigned	m_HomeRange

bool	m_HaveTerritory

int	m_KillEfficiency

Vole_Population_Manager *	m_Prey

TPredator_Population_Manager *	m_OurPopulationManager

vector< Vole_Base * > *	CurrentPrey

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 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...

Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

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 predators encompsassing all their general behaviours.

Defines simple predators that are really nothing more than moving mortality probabilities of different sizes and strengths. Breeding is once a year if enough prey are eaten, and death occurs if a starvation criteria is reached. The last individual cannot die so the population can never go extinct. If predators do not eat for a definable number of hunts then they may disperse, otherwise they move only locally. Different types of predators can be defined in the same simulation by defining the Weasel and Owl classes using configuration variables to create e.g. specialist or generalist predators, with different movement patterns, hunting efficiency and numerical responses.

Constructor & Destructor Documentation

◆ TPredator()

TPredator::TPredator	(	Vole_Population_Manager *	ThePrey,
		int	p_x,
		int	p_y,
		Landscape *	p_L,
		TPredator_Population_Manager *	p_PPM
	)

Tpredator constructor

                                                           : TAnimal(p_x,p_y)
 {
     CurrentPState=tops_InitialState;
     m_KillEfficiency=0;
     m_kills_this_season=0;
     m_FailureCount=0;
     m_NoFailuresBeforeDispersal=5; // Default
     m_OurPopulationManager=p_PPM;
     m_Prey = ThePrey;
     m_Search_x=m_Location_x;
     m_Search_y=m_Location_y;
     m_HomeRange=0;
     m_HaveTerritory=false;
     m_SearchArea=0;
     m_DispersalMax=0;
     SimH=m_OurLandscape->SupplySimAreaHeight();
     SimW=m_OurLandscape->SupplySimAreaWidth();
     PreyResponse1=0;
     PreyResponse2=0;
 }

References CurrentPState, m_DispersalMax, m_FailureCount, m_HaveTerritory, m_HomeRange, m_KillEfficiency, m_kills_this_season, TAnimal::m_Location_x, TAnimal::m_Location_y, m_NoFailuresBeforeDispersal, TAnimal::m_OurLandscape, m_OurPopulationManager, m_Prey, m_Search_x, m_Search_y, m_SearchArea, PreyResponse1, PreyResponse2, SimH, SimW, Landscape::SupplySimAreaHeight(), Landscape::SupplySimAreaWidth(), and tops_InitialState.

◆ ~TPredator()

TPredator::~TPredator ( )

 {
  
 }

Member Function Documentation

◆ BeginStep()

virtual void TPredator::BeginStep ( void )

inlinevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Owl, and Weasel.

130 {}

◆ EndStep()

virtual void TPredator::EndStep ( void )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Owl, and Weasel.

132 {}

◆ OverlapMyTerritory()

bool TPredator::OverlapMyTerritory	(	unsigned	x,
		unsigned	y
	)

 {
    // ensure we can't go negative
    x+=SimW;
    y+=SimH;
    unsigned mx = m_Location_x+SimW;
    unsigned my = m_Location_y+SimH;
    // most likely that it is not in so test for false
    if (x<mx-m_HomeRange) return false;
     else if (x>=mx+m_HomeRange) return false;
       else if (y<my-m_HomeRange) return false;
         else if (y>=my+m_HomeRange) return false;
          else return true;
 }

References m_HomeRange, TAnimal::m_Location_x, TAnimal::m_Location_y, SimH, and SimW.

Referenced by TPredator_Population_Manager::InOtherTerritory().

◆ st_Dispersal()

void TPredator::st_Dispersal ( void )

virtual

Moves the home range to an area where it does not overlap with a conspecific

 {
  
   bool found=false;
   unsigned Count=0;
   while ((!found)&&(Count<100))
   {
     // Simple random walk
     Count++;
     m_Location_x=((m_Location_x+(g_random_fnc(2*m_DispersalMax)-m_DispersalMax)))%SimW;
     m_Location_y=((m_Location_y+(g_random_fnc(2*m_DispersalMax)-m_DispersalMax)))%SimH;
     m_OurPopulationManager->UpdateGuardMap(m_Location_x,m_Location_y,m_guard_cell_x,m_guard_cell_y);
  
     if (!m_OurPopulationManager->InOtherTerritory(SpeciesID,m_Location_x,
                                                                  m_Location_y,this))
     {
       m_HaveTerritory=true;
       found=true;
     }
   }
 }

References g_random_fnc(), TPredator_Population_Manager::InOtherTerritory(), m_DispersalMax, TAnimal::m_guard_cell_x, TAnimal::m_guard_cell_y, m_HaveTerritory, TAnimal::m_Location_x, TAnimal::m_Location_y, m_OurPopulationManager, SimH, SimW, SpeciesID, and Population_Manager::UpdateGuardMap().

Referenced by Weasel::Step(), and Owl::Step().

◆ st_Hunting()

int TPredator::st_Hunting ( )

virtual

 {
    unsigned kills=0;
    // count days since last kill
    // Takes the Search_x, Search_y, SearchArea. Applies KillEfficiency to
    // all voles defined by this square
    CurrentPrey=m_Prey->SupplyVoleList(m_Search_x,m_Search_y,m_SearchArea);
    //int s=CurrentPrey->size();  // **CJT** to help with debug
    for (unsigned i=0; i<CurrentPrey->size(); i++)
    {
      if (g_random_fnc(1000)<m_KillEfficiency)
      {
       (*CurrentPrey)[i]->OnKilled();
       kills++;
      }
    }
    // Must tidy up here because m_Prey cannot know when to do it
    CurrentPrey->clear();
    delete CurrentPrey;
    // record the kills
    m_kills_this_season+=kills;
    return kills;
 }

References CurrentPrey, g_random_fnc(), m_KillEfficiency, m_kills_this_season, m_Prey, m_Search_x, m_Search_y, m_SearchArea, and Vole_Population_Manager::SupplyVoleList().

Referenced by Weasel::Step(), and Owl::Step().

◆ st_Movement()

void TPredator::st_Movement ( )

virtual

 {
    // Can relocate search_x & search_y to be up somewhere in the homerange
    // but must have all the square in the HomeRange
    // 1. Drift a bit
    m_Location_x+=g_random_fnc(3)-1;
    m_Location_y+=g_random_fnc(3)-1;
    m_Location_x=(SimW+m_Location_x)%SimW;
    m_Location_y=(SimH+m_Location_y)%SimH;
    m_OurPopulationManager->UpdateGuardMap(m_Location_x,m_Location_y,m_guard_cell_x,m_guard_cell_y);
    // 2. determine search area
    int max_dist=m_HomeRange-m_SearchArea;
    m_Search_x=(m_Location_x+g_random_fnc(max_dist))%SimW;
    m_Search_y=(m_Location_y+g_random_fnc(max_dist))%SimH;
 }