ALMaSS Skylark ODDox
1.1
The skylark model description following ODdox protocol
|
The base class of all ALMaSS objects requiring Step code. More...
#include <PopulationManager.h>
Public Member Functions | |
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 | 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 () |
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 Attributes | |
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 of all ALMaSS objects requiring Step code.
TALMaSSObject::TALMaSSObject | ( | ) |
The constructor for TALMaSSObject.
|
virtual |
The destructor for TALMaSSObject.
|
inlinevirtual |
BeingStep behaviour - must be implemented in descendent classes.
Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, and TAnimal.
|
inlinevirtual |
EndStep behaviour - must be implemented in descendent classes.
Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, and TAnimal.
|
inline |
Returns the current state number.
References m_CurrentStateNo.
|
inline |
void TALMaSSObject::OnArrayBoundsError | ( | ) |
Used for debugging only, tests basic object properties.
Referenced by Skylark_Female::GetFood(), Skylark_Male::GetFood(), Skylark_Male::OnAddNestling(), Skylark_Male::OnNestlingDeath(), Skylark_Male::OnPreFledgelingDeath(), and Skylark_Male::OnPreFledgelingMature().
|
inlinevirtual |
Used to re-use an object - must be implemented in descendent classes.
References m_CurrentStateNo, and m_StepDone.
Referenced by Skylark_Base::ReInit(), and TAnimal::ReinitialiseObject().
|
inline |
Sets the current state number.
References m_CurrentStateNo.
|
inline |
|
inlinevirtual |
Step behaviour - must be implemented in descendent classes.
Reimplemented in Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, and TAnimal.
|
protected |
The basic state number for all objects - '-1' indicates death.
Referenced by Skylark_Nestling::BeginStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), GetCurrentStateNo(), TAnimal::KillThis(), Skylark_Nestling::OnDeserted(), Skylark_Clutch::OnMumGone(), Skylark_Nestling::OnYouHaveBeenEaten(), Skylark_Base::ReInit(), ReinitialiseObject(), SetCurrentStateNo(), Skylark_Base::Skylark_Base(), Skylark_Clutch::st_Dying(), Skylark_Nestling::st_Dying(), Skylark_PreFledgeling::st_Dying(), Skylark_Female::st_Dying(), and Skylark_Male::st_Dying().
|
protected |
Indicates whether the iterative step code is done for this timestep.
Referenced by Skylark_Female::BeginStep(), Skylark_Male::BeginStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), GetStepDone(), TAnimal::KillThis(), ReinitialiseObject(), SetStepDone(), Skylark_Clutch::Step(), Skylark_Nestling::Step(), Skylark_PreFledgeling::Step(), Skylark_Female::Step(), and Skylark_Male::Step().