ALMaSS Skylark ODDox
1.1
The skylark 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()
TAnimal::TAnimal | ( | int | x, |
int | y, | ||
Landscape * | L | ||
) |
|
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.
void TAnimal::CheckManagement | ( | void | ) |
void TAnimal::CheckManagementXY | ( | int | x, |
int | y | ||
) |
|
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 m_Location_x, m_Location_y, m_OurLandscape, Landscape::SupplySimAreaHeight(), and Landscape::SupplySimAreaWidth().
|
inlinevirtual |
References KillThis().
Referenced by Skylark_Population_Manager::Catastrophe().
|
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.
|
inlinevirtual |
References TALMaSSObject::m_CurrentStateNo, and TALMaSSObject::m_StepDone.
Referenced by Dying().
|
inlinevirtual |
Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, and Skylark_Clutch.
|
inlinevirtual |
Used to re-use an object - must be implemented in descendent classes.
References m_Location_x, m_Location_y, m_OurLandscape, and TALMaSSObject::ReinitialiseObject().
|
inline |
References m_Location_x.
|
inline |
References m_Location_y.
|
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.
|
inline |
References m_Location_x.
Referenced by Skylark_Population_Manager::BreedingPairsOutput(), and Skylark_Population_Manager::TheRipleysOutputProbe().
|
inline |
References m_Location_y.
Referenced by Skylark_Population_Manager::BreedingPairsOutput(), and Skylark_Population_Manager::TheRipleysOutputProbe().
unsigned TAnimal::SupplyFarmOwnerRef | ( | ) |
|
inline |
References m_Location_x, and m_Location_y.
|
inline |
References m_Location_x, m_Location_y, m_OurLandscape, and Landscape::SupplyPolyRef().
AnimalPosition TAnimal::SupplyPosition | ( | ) |
|
inlinevirtual |
Reimplemented in Skylark_Base.
|
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().
|
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().
|
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().