ALMaSS Vole ODDox
1.1
The vole model description following ODdox protocol
|
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... | |
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 205 of file PopulationManager.h.
TAnimal::TAnimal | ( | int | x, |
int | y, | ||
Landscape * | L | ||
) |
TAnimal Constructor
Definition at line 1367 of file PopulationManager.cpp.
|
inlinevirtual |
BeingStep behaviour - must be implemented in descendent classes.
Reimplemented from TALMaSSObject.
Reimplemented in Owl, Weasel, TPredator, Vole_JuvenileFemale, Vole_JuvenileMale, and Vole_Base.
Definition at line 250 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 1404 of file PopulationManager.cpp.
References sleep_all_day.
Referenced by Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), and Vole_JuvenileFemale::EndStep().
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 1417 of file PopulationManager.cpp.
References sleep_all_day.
|
inlinevirtual |
Definition at line 224 of file PopulationManager.h.
|
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 231 of file PopulationManager.h.
References m_Location_x, m_Location_y, m_OurLandscape, Landscape::SupplySimAreaHeight(), and Landscape::SupplySimAreaWidth().
|
inlinevirtual |
Definition at line 266 of file PopulationManager.h.
References KillThis().
|
inlinevirtual |
EndStep behaviour - must be implemented in descendent classes.
Reimplemented from TALMaSSObject.
Reimplemented in Owl, Weasel, TPredator, Vole_JuvenileFemale, Vole_Male, Vole_JuvenileMale, and Vole_Base.
Definition at line 254 of file PopulationManager.h.
|
inlinevirtual |
Definition at line 219 of file PopulationManager.h.
References TALMaSSObject::m_CurrentStateNo, and TALMaSSObject::m_StepDone.
Referenced by Weasel::BeginStep(), Owl::BeginStep(), and Dying().
|
inlinevirtual |
Reimplemented in Vole_JuvenileFemale, and Vole_JuvenileMale.
Definition at line 271 of file PopulationManager.h.
|
inlinevirtual |
Used to re-use an object - must be implemented in descendent classes.
Definition at line 257 of file PopulationManager.h.
References m_Location_x, m_Location_y, m_OurLandscape, and TALMaSSObject::ReinitialiseObject().
|
inline |
Definition at line 240 of file PopulationManager.h.
References m_Location_x.
|
inline |
Definition at line 243 of file PopulationManager.h.
References m_Location_y.
|
inlinevirtual |
Step behaviour - must be implemented in descendent classes.
Reimplemented from TALMaSSObject.
Reimplemented in Owl, Weasel, TPredator, Vole_Female, Vole_JuvenileFemale, Vole_Male, Vole_JuvenileMale, and Vole_Base.
Definition at line 252 of file PopulationManager.h.
|
inline |
Definition at line 213 of file PopulationManager.h.
References m_Location_x.
Referenced by Vole_Population_Manager::DoFirst(), Population_Manager::FindClosest(), Vole_Population_Manager::FindOutsideRadiusMale(), Vole_Population_Manager::GeneticsOutputFile(), Vole_Population_Manager::GeneticsResultsOutput(), Vole_Population_Manager::LandscapeQuadrantOutputProbe(), CompareX::operator()(), TPredator_Population_Manager::PredSampleFile(), Vole_Population_Manager::TheAgeSexLocationProbe(), Vole_Population_Manager::TheReallyBigOutputProbe(), and Vole_Population_Manager::TheRipleysOutputProbe().
|
inline |
Definition at line 216 of file PopulationManager.h.
References m_Location_y.
Referenced by Vole_Population_Manager::DoFirst(), Vole_Population_Manager::FindOutsideRadiusMale(), Vole_Population_Manager::GeneticsOutputFile(), Vole_Population_Manager::LandscapeQuadrantOutputProbe(), CompareY::operator()(), TPredator_Population_Manager::PredSampleFile(), Vole_Population_Manager::TheAgeSexLocationProbe(), Vole_Population_Manager::TheReallyBigOutputProbe(), and Vole_Population_Manager::TheRipleysOutputProbe().
unsigned TAnimal::SupplyFarmOwnerRef | ( | ) |
Provides the farmer reference for the location of a TAnimal
Definition at line 1359 of file PopulationManager.cpp.
|
inline |
|
inline |
Definition at line 210 of file PopulationManager.h.
References m_Location_x, m_Location_y, m_OurLandscape, and Landscape::SupplyPolyRef().
AnimalPosition TAnimal::SupplyPosition | ( | ) |
Provides the location of an animal in terms of x,y,elementtype and vegetation type
Definition at line 1345 of file PopulationManager.cpp.
References AnimalPosition::m_EleType, AnimalPosition::m_VegType, AnimalPosition::m_x, and AnimalPosition::m_y.
Referenced by Vole_Male::st_Eval_n_Explore().
|
inlinevirtual |
Reimplemented in Vole_Base.
Definition at line 263 of file PopulationManager.h.
Referenced by CompareState::operator()().
|
protected |
Definition at line 225 of file PopulationManager.h.
Referenced by Weasel::BeginStep(), Owl::BeginStep(), Vole_Base::CalculateCarryingCapacity(), Vole_Male::CanFeed(), Vole_Base::CheckTraps(), Vole_Base::CopyMyself(), CorrectWrapRound(), Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_Base::Escape(), Vole_JuvenileMale::FreeLocation(), Vole_JuvenileFemale::FreeLocation(), Vole_Base::Init(), Vole_Base::MoveTo(), TPredator::OverlapMyTerritory(), ReinitialiseObject(), Vole_Base::RodenticideIngestion(), Vole_JuvenileMale::SetLocation(), Vole_JuvenileFemale::SetLocation(), SetX(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), TPredator::st_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(), Vole_Male::st_Infanticide(), Vole_Female::st_Lactating(), Vole_Female::st_Mating(), TPredator::st_Movement(), Vole_Female::st_Special_Explore(), Supply_m_Location_x(), Vole_Base::SupplyElemType(), SupplyPoint(), SupplyPolygonRef(), Vole_Base::SupplyX(), and TPredator::TPredator().
|
protected |
Definition at line 228 of file PopulationManager.h.
Referenced by Weasel::BeginStep(), Owl::BeginStep(), Vole_Base::CalculateCarryingCapacity(), Vole_Male::CanFeed(), Vole_Base::CheckTraps(), Vole_Base::CopyMyself(), CorrectWrapRound(), Vole_JuvenileMale::Dispersal(), Vole_Male::Dispersal(), Vole_JuvenileFemale::Dispersal(), Vole_Base::Escape(), Vole_JuvenileMale::FreeLocation(), Vole_JuvenileFemale::FreeLocation(), Vole_Base::Init(), Vole_Base::MoveTo(), TPredator::OverlapMyTerritory(), ReinitialiseObject(), Vole_Base::RodenticideIngestion(), Vole_JuvenileMale::SetLocation(), Vole_JuvenileFemale::SetLocation(), SetY(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), TPredator::st_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(), Vole_Male::st_Infanticide(), Vole_Female::st_Lactating(), Vole_Female::st_Mating(), TPredator::st_Movement(), Vole_Female::st_Special_Explore(), Supply_m_Location_y(), Vole_Base::SupplyElemType(), SupplyPoint(), SupplyPolygonRef(), Vole_Base::SupplyY(), and TPredator::TPredator().
|
protected |
Definition at line 229 of file PopulationManager.h.
Referenced by Weasel::BeginStep(), Owl::BeginStep(), Vole_Base::CalculateCarryingCapacity(), Vole_Base::CheckTraps(), Vole_Base::CopyMyself(), CorrectWrapRound(), Vole_JuvenileMale::EndStep(), Vole_Male::EndStep(), Vole_JuvenileFemale::EndStep(), Vole_Base::Init(), Vole_Base::MoveQuality(), Vole_JuvenileMale::OnFarmEvent(), Vole_JuvenileFemale::OnFarmEvent(), ReinitialiseObject(), Vole_Base::RodenticideIngestion(), Vole_Base::Set_ElemBorn(), Vole_Base::Set_PolyRefBorn(), Vole_Base::Set_VegBorn(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Vole_Female::st_GiveBirth(), Vole_Female::st_Lactating(), Vole_Male::st_Maturation(), Weasel::Step(), Owl::Step(), Vole_JuvenileMale::Step(), Vole_Male::Step(), Vole_JuvenileFemale::Step(), Vole_Female::Step(), Vole_Base::SupplyElemType(), SupplyPolygonRef(), and TPredator::TPredator().