ALMaSS Hare ODDox
1.1
The hare model description following ODdox protocol
|
The base class of all ALMaSS objects requiring Step code. More...
#include <PopulationManager.h>
Public Member Functions | |
virtual void | BeginStep (void) |
BeingStep behaviour - must be implemented in descendent classes. More... | |
virtual void | EndStep (void) |
EndStep behaviour - must be implemented in descendent classes. More... | |
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... | |
virtual void | Step (void) |
Step behaviour - must be implemented in descendent classes. More... | |
TALMaSSObject () | |
The constructor for TALMaSSObject. More... | |
virtual | ~TALMaSSObject () |
The destructor for TALMaSSObject. 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.
Definition at line 113 of file PopulationManager.h.
TALMaSSObject::TALMaSSObject | ( | ) |
The constructor for TALMaSSObject.
TALMaSSObject Constructor
Definition at line 1379 of file PopulationManager.cpp.
|
virtual |
The destructor for TALMaSSObject.
TALMaSSObject Destructor
Definition at line 1393 of file PopulationManager.cpp.
|
inlinevirtual |
BeingStep behaviour - must be implemented in descendent classes.
Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, THare, and TAnimal.
Definition at line 137 of file PopulationManager.h.
|
inlinevirtual |
EndStep behaviour - must be implemented in descendent classes.
Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, THare, and TAnimal.
Definition at line 141 of file PopulationManager.h.
|
inline |
Returns the current state number.
Definition at line 121 of file PopulationManager.h.
References m_CurrentStateNo.
Referenced by THare_Population_Manager::Hunting(), THare_Population_Manager::HuntingGrid(), CompareStateR::operator()(), CompareStateDead::operator()(), and CompareStateAlive::operator()().
|
inline |
Returns the step done indicator flag.
Definition at line 129 of file PopulationManager.h.
References m_StepDone.
void TALMaSSObject::OnArrayBoundsError | ( | ) |
Used for debugging only, tests basic object properties.
Definition at line 1427 of file PopulationManager.cpp.
|
inlinevirtual |
Used to re-use an object - must be implemented in descendent classes.
Definition at line 143 of file PopulationManager.h.
References m_CurrentStateNo, and m_StepDone.
Referenced by TAnimal::ReinitialiseObject().
|
inline |
Sets the current state number.
Definition at line 125 of file PopulationManager.h.
References m_CurrentStateNo.
|
inline |
Sets the step done indicator flag.
Definition at line 133 of file PopulationManager.h.
References m_StepDone.
|
inlinevirtual |
Step behaviour - must be implemented in descendent classes.
Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, THare, and TAnimal.
Definition at line 139 of file PopulationManager.h.
|
protected |
The basic state number for all objects - '-1' indicates death.
Definition at line 116 of file PopulationManager.h.
Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), GetCurrentStateNo(), TAnimal::KillThis(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), Hare_Infant::ReInit(), Hare_Young::ReInit(), Hare_Juvenile::ReInit(), Hare_Male::ReInit(), Hare_Female::ReInit(), ReinitialiseObject(), SetCurrentStateNo(), THare::st_Dying(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), and Hare_Female::Step().
|
protected |
Indicates whether the iterative step code is done for this timestep.
Definition at line 118 of file PopulationManager.h.
Referenced by Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Hare_Male::GeneralOrganoPhosphate(), Hare_Female::GeneralOrganoPhosphate(), GetStepDone(), TAnimal::KillThis(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), ReinitialiseObject(), SetStepDone(), THare::st_Dying(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), and Hare_Female::Step().