TAnimal Class Reference

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

#include <PopulationManager.h>

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()

Constructor & Destructor Documentation

TAnimal()

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

Member Function Documentation

BeginStep()

virtual void TAnimal::BeginStep ( void  )

inlinevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, and Skylark_Clutch.

                                 {
  }

CheckManagement()

void TAnimal::CheckManagement

(

void

)

Referenced by Skylark_Clutch::BeginStep(), Skylark_Nestling::BeginStep(), Skylark_PreFledgeling::BeginStep(), Skylark_Female::BeginStep(), and Skylark_Male::BeginStep().

CheckManagementXY()

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

CopyMyself()

virtual void TAnimal::CopyMyself ( )

inlinevirtual

                            {
  };

CorrectWrapRound()

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.

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

References m_Location_x, m_Location_y, m_OurLandscape, Landscape::SupplySimAreaHeight(), and Landscape::SupplySimAreaWidth().

Dying()

virtual void TAnimal::Dying ( )

inlinevirtual

                       {
    KillThis();
  }

References KillThis().

Referenced by Skylark_Population_Manager::Catastrophe().

EndStep()

virtual void TAnimal::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, and Skylark_Clutch.

                               {
  }

KillThis()

virtual void TAnimal::KillThis ( )

inlinevirtual

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

References TALMaSSObject::m_CurrentStateNo, and TALMaSSObject::m_StepDone.

Referenced by Dying().

OnFarmEvent()

virtual bool TAnimal::OnFarmEvent ( FarmToDo  )

inlinevirtual

Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, and Skylark_Clutch.

                                         {
    return false;
  }

ReinitialiseObject()

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

inlinevirtual

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

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

References m_Location_x, m_Location_y, m_OurLandscape, and TALMaSSObject::ReinitialiseObject().

SetX()

void TAnimal::SetX ( int  a_x )

inline

                       {
    m_Location_x = a_x;
  }

References m_Location_x.

SetY()

void TAnimal::SetY ( int  a_y )

inline

                       {
 
    m_Location_y = a_y;
 
  }

References m_Location_y.

Step()

virtual void TAnimal::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, and Skylark_Clutch.

                            {
  }

Supply_m_Location_x()

int TAnimal::Supply_m_Location_x ( )

inline

                            {
    return m_Location_x;
  }

References m_Location_x.

Referenced by Skylark_Population_Manager::BreedingPairsOutput(), and Skylark_Population_Manager::TheRipleysOutputProbe().

Supply_m_Location_y()

int TAnimal::Supply_m_Location_y ( )

inline

                            {
    return m_Location_y;
  }

References m_Location_y.

Referenced by Skylark_Population_Manager::BreedingPairsOutput(), and Skylark_Population_Manager::TheRipleysOutputProbe().

SupplyFarmOwnerRef()

unsigned TAnimal::SupplyFarmOwnerRef

(

)

SupplyPoint()

APoint TAnimal::SupplyPoint ( )

inline

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

References m_Location_x, and m_Location_y.

SupplyPolygonRef()

int TAnimal::SupplyPolygonRef ( )

inline

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

References m_Location_x, m_Location_y, m_OurLandscape, and Landscape::SupplyPolyRef().

SupplyPosition()

AnimalPosition TAnimal::SupplyPosition

(

)

WhatState()

virtual int TAnimal::WhatState ( )

inlinevirtual

Reimplemented in Skylark_Base.

                          {
    return 0;
  }

Member Data Documentation

m_Location_x

int TAnimal::m_Location_x

protected

Referenced by Skylark_Adult::CopyMyself(), CorrectWrapRound(), Skylark_Male::EstablishingATerritory(), Skylark_Female::EstablishTerritory(), Skylark_Base::InSquare(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_Male::OnNestLocation(), ReinitialiseObject(), SetX(), Skylark_Female::st_Arriving(), Skylark_Female::st_Finding_Territory(), Skylark_Male::st_FindingTerritory(), Skylark_Female::st_Floating(), Skylark_Male::st_Floating(), Skylark_Female::st_Flocking(), Skylark_Male::st_Flocking(), Skylark_Clutch::st_Hatching(), Skylark_Female::st_Laying(), Skylark_Female::st_MakingNest(), Skylark_Nestling::st_Maturing(), Skylark_PreFledgeling::st_Maturing(), Skylark_Female::Step(), Skylark_Male::Step(), Supply_m_Location_x(), SupplyPoint(), and SupplyPolygonRef().

m_Location_y

int TAnimal::m_Location_y

protected

Referenced by Skylark_Adult::CopyMyself(), CorrectWrapRound(), Skylark_Male::EstablishingATerritory(), Skylark_Female::EstablishTerritory(), Skylark_Base::InSquare(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_Male::OnNestLocation(), ReinitialiseObject(), SetY(), Skylark_Female::st_Arriving(), Skylark_Female::st_Finding_Territory(), Skylark_Male::st_FindingTerritory(), Skylark_Female::st_Floating(), Skylark_Male::st_Floating(), Skylark_Female::st_Flocking(), Skylark_Male::st_Flocking(), Skylark_Clutch::st_Hatching(), Skylark_Female::st_Laying(), Skylark_Female::st_MakingNest(), Skylark_Nestling::st_Maturing(), Skylark_PreFledgeling::st_Maturing(), Skylark_Female::Step(), Skylark_Male::Step(), Supply_m_Location_y(), SupplyPoint(), and SupplyPolygonRef().

m_OurLandscape

Landscape* TAnimal::m_OurLandscape

protected

Referenced by Skylark_Female::CheckForFields(), Skylark_Adult::CopyMyself(), CorrectWrapRound(), Skylark_Female::FeedYoung(), Skylark_Male::GetFood(), Skylark_Adult::GetVegHindrance(), Skylark_Adult::GetWeatherHindrance(), Skylark_Nestling::OnDeserted(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_PreFledgeling::OnFarmEvent(), Skylark_Female::OnFarmEvent(), Skylark_Male::OnFarmEvent(), Skylark_Female::OnMateDying(), Skylark_Male::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Nestling::OnYouHaveBeenEaten(), ReinitialiseObject(), Skylark_Female::st_Arriving(), Skylark_Male::st_AttractingAMate(), Skylark_Female::st_BuildingUpResources(), Skylark_Female::st_CaringForYoung(), Skylark_Male::st_CaringForYoung(), Skylark_Clutch::st_Developing(), Skylark_Nestling::st_Developing(), Skylark_Female::st_Dying(), Skylark_Female::st_Emigrating(), Skylark_Male::st_Emigrating(), Skylark_Female::st_Floating(), Skylark_Male::st_Floating(), Skylark_Female::st_Flocking(), Skylark_Male::st_Flocking(), Skylark_Female::st_GivingUpTerritory(), Skylark_Clutch::st_Hatching(), Skylark_Female::st_Incubating(), Skylark_Female::st_Laying(), Skylark_Female::st_MakingNest(), Skylark_Nestling::st_Maturing(), Skylark_PreFledgeling::st_Maturing(), Skylark_Female::st_PreparingForBreeding(), Skylark_Female::st_StartingNewBrood(), Skylark_Female::st_StoppingBreeding(), Skylark_Female::Step(), and SupplyPolygonRef().

---

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

• C:/Repo/ALMaSS_all/BatchALMaSS/PopulationManager.h