ALMaSS Rodenticide ODdox
1.1
The rodenticide 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 | ( | ) |
|
virtual |
The destructor for TALMaSSObject.
TALMaSSObject Destructor
|
inlinevirtual |
|
inlinevirtual |
|
inline |
Returns the current state number.
References m_CurrentStateNo.
Referenced by CompareStateR::operator()(), CompareStateDead::operator()(), and CompareStateAlive::operator()().
|
inline |
void TALMaSSObject::OnArrayBoundsError | ( | ) |
|
inlinevirtual |
Used to re-use an object - must be implemented in descendent classes.
References m_CurrentStateNo, and m_StepDone.
Referenced by TAnimal::ReinitialiseObject().
|
inline |
Sets the current state number.
References m_CurrentStateNo.
|
inline |
|
inlinevirtual |
|
protected |
The basic state number for all objects - '-1' indicates death.
Referenced by GetCurrentStateNo(), TAnimal::KillThis(), ReinitialiseObject(), and SetCurrentStateNo().
|
protected |
Indicates whether the iterative step code is done for this timestep.
Referenced by GetStepDone(), TAnimal::KillThis(), ReinitialiseObject(), and SetStepDone().