TAnimal Class Reference

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

#include <PopulationManager.h>

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

TAnimal Constructor

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

                                 {
  }

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.

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

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

virtual void TAnimal::CopyMyself ( )

inlinevirtual

                            {
  };

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.

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

                       {
    KillThis();
  }

virtual void TAnimal::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

                               {
  }

virtual void TAnimal::KillThis ( )

inlinevirtual

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

virtual bool TAnimal::OnFarmEvent ( FarmToDo  )

inlinevirtual

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

References TALMaSSObject::ReinitialiseObject().

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

void TAnimal::SetX ( int  a_x )

inline

                       {
    m_Location_x = a_x;
  }

void TAnimal::SetY ( int  a_y )

inline

                       {

    m_Location_y = a_y;

  }

virtual void TAnimal::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented from TALMaSSObject.

                            {
  }

int TAnimal::Supply_m_Location_x ( )

inline

Referenced by CompareX::operator()().

                            {
    return m_Location_x;
  }

int TAnimal::Supply_m_Location_y ( )

inline

Referenced by CompareY::operator()().

                            {
    return m_Location_y;
  }

unsigned TAnimal::SupplyFarmOwnerRef

(

)

Provides the farmer reference for the location of a TAnimal

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

APoint TAnimal::SupplyPoint ( )

inline

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

int TAnimal::SupplyPolygonRef ( )

inline

                         {
        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

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

Referenced by CompareState::operator()().

                          {
    return 0;
  }

Member Data Documentation

int TAnimal::m_Location_x

protected

int TAnimal::m_Location_y

protected

Landscape* TAnimal::m_OurLandscape

protected

---

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

• PopulationManager.h
• PopulationManager.cpp