TAnimal Class Reference

The base class for all ALMaSS animal classes. More...

#include <populationmanager.h>

Inheritance diagram for TAnimal:

Public Member Functions
unsigned	SupplyFarmOwnerRef ()
AnimalPosition	SupplyPosition ()
APoint	SupplyPoint ()
int	SupplyPolygonRef ()
int	Supply_m_Location_x ()
int	Supply_m_Location_y ()
virtual void	KillThis ()
virtual void	CopyMyself ()
void	SetX (int a_x)
void	SetY (int a_y)
	TAnimal (int x, int y, Landscape *L)
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...
virtual void	ReinitialiseObject (int x, int y, Landscape *L)
	Used to re-use an object - must be implemented in descendent classes. More...
virtual int	WhatState ()
virtual void	Dying ()
void	CheckManagement (void)
void	CheckManagementXY (int x, int y)
virtual bool	OnFarmEvent (FarmToDo)
Public Member Functions inherited from TALMaSSObject
int	GetCurrentStateNo ()
	Returns the current state number. More...
void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...
bool	GetStepDone ()
	Returns the step done indicator flag. More...
void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...
virtual void	ReinitialiseObject ()
	Used to re-use an object - must be implemented in descendent classes. More...
	TALMaSSObject ()
	The constructor for TALMaSSObject. More...
virtual	~TALMaSSObject ()
	The destructor for TALMaSSObject. More...
void	OnArrayBoundsError ()
	Used for debugging only, tests basic object properties. More...

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

Protected Attributes
int	m_Location_x
int	m_Location_y
Landscape *	m_OurLandscape
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...

Detailed Description

The base class for all ALMaSS animal classes.

Includes all the functionality required to be handled by classes derived from Population_Manager, hence a number of empty methods that MUST be reimplemented in descendent classes e.g. CopyMyself()

Definition at line 201 of file populationmanager.h.

Constructor & Destructor Documentation

TAnimal::TAnimal	(	int	x,
		int	y,
		Landscape *	L
	)

TAnimal Constructor

Definition at line 1437 of file PopulationManager.cpp.

                                              {
  m_OurLandscape = L;
  m_Location_x = x;
  m_Location_y = y;
}

Member Function Documentation

virtual void TAnimal::BeginStep ( void  )

inlinevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Rabbit_Warren, and Rabbit_Base.

Definition at line 246 of file populationmanager.h.

                                 {
  }

void TAnimal::CheckManagement

(

void

)

Checks to see if there has been a management event at the TAnimals' x,y location. If so calls an event handler to handle the management event.

Definition at line 1474 of file PopulationManager.cpp.

References sleep_all_day.

                                    {
  FarmToDo event;
  int i = 0;
  while ( ( event = ( FarmToDo )m_OurLandscape->SupplyLastTreatment( m_Location_x, m_Location_y, & i ) ) != sleep_all_day ) {
    if ( OnFarmEvent( event ) ) break;
  }
}

void TAnimal::CheckManagementXY	(	int	x,
		int	y
	)

Checks to see if there has been a management event at the x,y location. If so calls an event handler to handle the management event.

Definition at line 1487 of file PopulationManager.cpp.

References sleep_all_day.

                                              {
  FarmToDo event;
  int i = 0;
  while ( ( event = ( FarmToDo )m_OurLandscape->SupplyLastTreatment( x, y, & i ) ) != sleep_all_day ) {
    OnFarmEvent( event );
  }
}

virtual void TAnimal::CopyMyself ( )

inlinevirtual

Definition at line 220 of file populationmanager.h.

                            {
  };

void TAnimal::CorrectWrapRound ( )

inlineprotected

Corrects wrap around co-ordinate problems.

Does the standard wrap around testing of positions. Uses the addition and modulus operators to avoid testing for negative or > landscape extent. This would be an alternative that should be tested for speed at some point.

Definition at line 227 of file populationmanager.h.

References Landscape::SupplySimAreaHeight(), and Landscape::SupplySimAreaWidth().

                          {
    m_Location_x = (m_Location_x + m_OurLandscape->SupplySimAreaWidth()) % m_OurLandscape->SupplySimAreaWidth();
    m_Location_y = (m_Location_y + m_OurLandscape->SupplySimAreaHeight()) % m_OurLandscape->SupplySimAreaHeight();
  }

virtual void TAnimal::Dying ( )

inlinevirtual

Definition at line 262 of file populationmanager.h.

                       {
    KillThis();
  }

virtual void TAnimal::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Rabbit_Adult, Rabbit_Juvenile, Rabbit_Young, and Rabbit_Base.

Definition at line 250 of file populationmanager.h.

                               {
  }

virtual void TAnimal::KillThis ( )

inlinevirtual

Definition at line 215 of file populationmanager.h.

  {
    m_CurrentStateNo = -1;
    m_StepDone = true;
  };

virtual bool TAnimal::OnFarmEvent ( FarmToDo  )

inlinevirtual

Definition at line 267 of file populationmanager.h.

                                         {
    return false;
  }

virtual void TAnimal::ReinitialiseObject ( int  x, int  y, Landscape *  L  )

inlinevirtual

Used to re-use an object - must be implemented in descendent classes.

Definition at line 253 of file populationmanager.h.

References TALMaSSObject::ReinitialiseObject().

                                                               {
      m_OurLandscape = L;
      m_Location_x = x;
      m_Location_y = y;
      TALMaSSObject::ReinitialiseObject();
  }

void TAnimal::SetX ( int  a_x )

inline

Definition at line 236 of file populationmanager.h.

                       {
    m_Location_x = a_x;
  }

void TAnimal::SetY ( int  a_y )

inline

Definition at line 239 of file populationmanager.h.

                       {

    m_Location_y = a_y;

  }

virtual void TAnimal::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Rabbit_Warren, Rabbit_Female, Rabbit_Male, Rabbit_Juvenile, Rabbit_Young, and Rabbit_Base.

Definition at line 248 of file populationmanager.h.

                            {
  }

int TAnimal::Supply_m_Location_x ( )

inline

Definition at line 209 of file populationmanager.h.

Referenced by Population_Manager::FindClosest(), CompareX::operator()(), Rabbit_Male::st_EvaluateTerritory(), and Rabbit_Female::st_EvaluateTerritory().

                            {
    return m_Location_x;
  }

int TAnimal::Supply_m_Location_y ( )

inline

Definition at line 212 of file populationmanager.h.

Referenced by CompareY::operator()(), Rabbit_Male::st_EvaluateTerritory(), and Rabbit_Female::st_EvaluateTerritory().

                            {
    return m_Location_y;
  }

unsigned TAnimal::SupplyFarmOwnerRef

(

)

Provides the farmer reference for the location of a TAnimal

Definition at line 1429 of file PopulationManager.cpp.

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

APoint TAnimal::SupplyPoint ( )

inline

Definition at line 205 of file populationmanager.h.

{ APoint p( m_Location_x, m_Location_y); return p; }

int TAnimal::SupplyPolygonRef ( )

inline

Definition at line 206 of file populationmanager.h.

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

AnimalPosition TAnimal::SupplyPosition

(

)

Provides the location of an animal in terms of x,y,elementtype and vegetation type

Definition at line 1415 of file PopulationManager.cpp.

References AnimalPosition::m_EleType, AnimalPosition::m_VegType, AnimalPosition::m_x, and AnimalPosition::m_y.

                                       {
  AnimalPosition SkP;
  SkP.m_x = m_Location_x;
  SkP.m_y = m_Location_y;
  SkP.m_EleType = m_OurLandscape->SupplyElementType( m_Location_x, m_Location_y );
  SkP.m_VegType = m_OurLandscape->SupplyVegType( m_Location_x, m_Location_y );
  return SkP;
}

virtual int TAnimal::WhatState ( )

inlinevirtual

Definition at line 259 of file populationmanager.h.

Referenced by CompareState::operator()().

                          {
    return 0;
  }

Member Data Documentation

int TAnimal::m_Location_x

protected

Definition at line 221 of file populationmanager.h.

Referenced by Rabbit_Warren::Rabbit_Warren(), Rabbit_Juvenile::st_BecomeAdult(), Rabbit_Young::st_BecomeJuvenile(), Rabbit_Male::st_EvaluateTerritory(), Rabbit_Female::st_EvaluateTerritory(), Rabbit_Female::st_GiveBirth(), and Rabbit_Base::WalkTo().

int TAnimal::m_Location_y

protected

Definition at line 224 of file populationmanager.h.

Referenced by Rabbit_Warren::Rabbit_Warren(), Rabbit_Juvenile::st_BecomeAdult(), Rabbit_Young::st_BecomeJuvenile(), Rabbit_Male::st_EvaluateTerritory(), Rabbit_Female::st_EvaluateTerritory(), Rabbit_Female::st_GiveBirth(), and Rabbit_Base::WalkTo().

Landscape* TAnimal::m_OurLandscape

protected

Definition at line 225 of file populationmanager.h.

Referenced by Rabbit_Warren::DEBUG_InternalTest(), Rabbit_Warren::DEBUG_InternalTest2(), Rabbit_Warren::InitEvaluation(), Rabbit_Juvenile::InternalPesticideHandlingAndResponse(), Rabbit_Male::InternalPesticideHandlingAndResponse(), Rabbit_Female::InternalPesticideHandlingAndResponse(), Rabbit_Warren::JoinNOccupy(), Rabbit_Warren::Leave(), Rabbit_Adult::OnMateDead(), Rabbit_Adult::OnMateFinishedDigging(), Rabbit_Female::OnYoungDeath(), Rabbit_Female::Rabbit_Female(), Rabbit_Adult::SetMate(), Rabbit_Juvenile::st_BecomeAdult(), Rabbit_Young::st_BecomeJuvenile(), Rabbit_Female::st_EvaluateTerritory(), Rabbit_Female::st_GiveBirth(), Rabbit_Young::Step(), Rabbit_Juvenile::Step(), Rabbit_Male::Step(), Rabbit_Female::Step(), Rabbit_Warren::Step(), Rabbit_Warren::UpdateForageInformation(), Rabbit_Warren::UpdatePesticide(), and Rabbit_Female::Weaned().

---

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

• D:/CJT/Repos/ALMaSS_all/BatchALMaSS/populationmanager.h
• D:/CJT/Repos/ALMaSS_all/BatchALMaSS/PopulationManager.cpp