TALMaSSObject Class Reference

The base class of all ALMaSS objects requiring Step code. More...

#include <PopulationManager.h>

Inheritance diagram for TALMaSSObject:

Public Member Functions
int	GetCurrentStateNo () const
	Returns the current state number. More...
void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...
bool	GetStepDone () const
	Returns the step done indicator flag. More...
void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...
virtual void	BeginStep ()
	BeingStep behaviour - must be implemented in descendent classes. More...
virtual void	Step ()
	Step behaviour - must be implemented in descendent classes. More...
virtual void	EndStep ()
	EndStep behaviour - must be implemented in descendent classes. More...
void	ReinitialiseObjectBase ()
	Used to initialise an object. More...
	TALMaSSObject ()
	The constructor for TALMaSSObject. More...
virtual	~TALMaSSObject ()=default
	The destructor for TALMaSSObject. More...

Static Public Member Functions
static 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...

Detailed Description

The base class of all ALMaSS objects requiring Step code.

Constructor & Destructor Documentation

TALMaSSObject()

TALMaSSObject::TALMaSSObject

(

)

The constructor for TALMaSSObject.

TALMaSSObject Constructor

                             {
#ifdef __CJTDebug_5
  AmAlive = 0xDEADC0DE;
#endif
    m_StepDone = false;
    m_CurrentStateNo = 0;
}

References m_CurrentStateNo, and m_StepDone.

~TALMaSSObject()

virtual TALMaSSObject::~TALMaSSObject ( )

virtualdefault

The destructor for TALMaSSObject.

Member Function Documentation

BeginStep()

virtual void TALMaSSObject::BeginStep ( void  )

inlinevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, THare, Osmia_Female, Osmia_Base, Owl, Weasel, TPredator, Aphid, Beetle_Base, Beetle_Adult, Beetle_Pupae, Beetle_Larvae, Vole_JuvenileFemale, Vole_JuvenileMale, Beetle_Egg_List, Ladybird_Adult, Vole_Base, Ladybird_Pupae, Ladybird_Larvae1, Spider_Female, Spider_Juvenile, Spider_Egg, and SubPopulation.

                             {
    }

Referenced by TPredator_Population_Manager::Run().

EndStep()

virtual void TALMaSSObject::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, THare, Osmia_Base, Owl, Weasel, TPredator, Beetle_Adult, Beetle_Pupae, Beetle_Larvae, Vole_JuvenileFemale, Vole_Male, Vole_JuvenileMale, Vole_Base, Spider_Female, Spider_Juvenile, and Spider_Egg.

                           {
    }

Referenced by TPredator_Population_Manager::Run().

GetCurrentStateNo()

int TALMaSSObject::GetCurrentStateNo ( ) const

inline

Returns the current state number.

{ return m_CurrentStateNo; }

References m_CurrentStateNo.

Referenced by Vole_Population_Manager::FindOutsideRadiusMale(), Vole_Population_Manager::FindRandomMale(), CompareStateAlive::operator()(), CompareStateR::operator()(), CompareStateDead::operator()(), TPredator_Population_Manager::Run(), Population_Manager::SortStateR(), and Beetle_Population_Manager::TheRipleysOutputProbe().

GetStepDone()

bool TALMaSSObject::GetStepDone ( ) const

inline

Returns the step done indicator flag.

{ return m_StepDone; }

References m_StepDone.

Referenced by TPredator_Population_Manager::StepFinished().

OnArrayBoundsError()

void TALMaSSObject::OnArrayBoundsError ( )

static

Used for debugging only, tests basic object properties.

{ exit(1); }

Referenced by Skylark_Female::GetFood(), Skylark_Male::GetFood(), Skylark_Male::OnAddNestling(), Skylark_Male::OnNestlingDeath(), Skylark_Male::OnPreFledgelingDeath(), and Skylark_Male::OnPreFledgelingMature().

ReinitialiseObjectBase()

void TALMaSSObject::ReinitialiseObjectBase ( )

inline

Used to initialise an object.

                                  {
        m_StepDone = false;
        m_CurrentStateNo = 0;
    }

References m_CurrentStateNo, and m_StepDone.

Referenced by TAnimal::ReinitialiseObject().

SetCurrentStateNo()

void TALMaSSObject::SetCurrentStateNo ( int  a_num )

inline

Sets the current state number.

{ m_CurrentStateNo = a_num; }

References m_CurrentStateNo.

SetStepDone()

void TALMaSSObject::SetStepDone ( bool  a_bool )

inline

Sets the step done indicator flag.

{ m_StepDone = a_bool; }

References m_StepDone.

Referenced by TPredator_Population_Manager::Run().

Step()

virtual void TALMaSSObject::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented in Hare_Female, Hare_Male, Hare_Juvenile, Hare_Young, Hare_Infant, Skylark_Male, Skylark_Female, Skylark_PreFledgeling, Skylark_Nestling, Skylark_Clutch, THare, Osmia_Female, Osmia_InCocoon, Osmia_Pupa, Osmia_Prepupa, Osmia_Larva, Osmia_Egg, Osmia_Base, Owl, Weasel, TPredator, Beetle_Base, Beetle_Adult, Beetle_Pupae, Vole_Female, Beetle_Larvae, Vole_JuvenileFemale, Vole_Male, Vole_JuvenileMale, Beetle_Egg_List, Vole_Base, Spider_Female, Spider_Juvenile, Spider_Egg, and SubPopulation.

                        {
    }

Referenced by TPredator_Population_Manager::Run().

Member Data Documentation

m_CurrentStateNo

int TALMaSSObject::m_CurrentStateNo

protected

The basic state number for all objects - '-1' indicates death.

Referenced by Spider_Juvenile::BeginStep(), Spider_Female::BeginStep(), Skylark_Nestling::BeginStep(), Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), GetCurrentStateNo(), Vole_Base::Init(), Beetle_Base::KillAndRemoveFromMap(), TAnimal::KillThis(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), Skylark_Nestling::OnDeserted(), Skylark_Clutch::OnMumGone(), Skylark_Nestling::OnYouHaveBeenEaten(), Skylark_Base::ReInit(), Hare_Infant::ReInit(), Hare_Young::ReInit(), Hare_Juvenile::ReInit(), Hare_Male::ReInit(), Hare_Female::ReInit(), ReinitialiseObjectBase(), SetCurrentStateNo(), Skylark_Base::Skylark_Base(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Spider_Egg::st_Die(), Vole_Base::st_Dying(), THare::st_Dying(), Skylark_Clutch::st_Dying(), Skylark_Nestling::st_Dying(), Skylark_PreFledgeling::st_Dying(), Skylark_Female::st_Dying(), Skylark_Male::st_Dying(), Ladybird_Pupae::St_Emerge(), Beetle_Pupae::St_Emerge(), Spider_Egg::st_Hatch(), Beetle_Larvae::St_NextStage(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), Beetle_Base::StDie(), Weasel::Step(), Owl::Step(), Spider_Egg::Step(), Beetle_Egg_List::Step(), Osmia_Egg::Step(), Spider_Juvenile::Step(), Osmia_Larva::Step(), Osmia_Prepupa::Step(), Vole_JuvenileMale::Step(), Osmia_Pupa::Step(), Spider_Female::Step(), Osmia_InCocoon::Step(), Vole_Male::Step(), Beetle_Larvae::Step(), Osmia_Female::Step(), Beetle_Pupae::Step(), Beetle_Adult::Step(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), Hare_Female::Step(), and TALMaSSObject().

m_StepDone

bool TALMaSSObject::m_StepDone

protected

Indicates whether the iterative step code is done for this timestep.

Referenced by Spider_Juvenile::BeginStep(), Vole_JuvenileMale::BeginStep(), Spider_Female::BeginStep(), Vole_JuvenileFemale::BeginStep(), Skylark_Female::BeginStep(), Skylark_Male::BeginStep(), Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Hare_Male::GeneralOrganoPhosphate(), Hare_Female::GeneralOrganoPhosphate(), GetStepDone(), Beetle_Base::KillAndRemoveFromMap(), TAnimal::KillThis(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), ReinitialiseObjectBase(), SetStepDone(), Spider_Female::st_Balloon(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Spider_Egg::st_Develop(), THare::st_Dying(), Hare_Young::st_NextStage(), Spider_Juvenile::st_Walk(), Spider_Female::st_Walk(), Beetle_Base::StDie(), Weasel::Step(), Owl::Step(), Spider_Egg::Step(), Beetle_Egg_List::Step(), Osmia_Egg::Step(), Spider_Juvenile::Step(), Osmia_Larva::Step(), Osmia_Prepupa::Step(), Vole_JuvenileMale::Step(), Osmia_Pupa::Step(), Spider_Female::Step(), Osmia_InCocoon::Step(), Vole_Male::Step(), Vole_JuvenileFemale::Step(), Beetle_Larvae::Step(), Skylark_Clutch::Step(), Vole_Female::Step(), Skylark_Nestling::Step(), Skylark_PreFledgeling::Step(), Osmia_Female::Step(), Beetle_Pupae::Step(), Skylark_Female::Step(), Beetle_Adult::Step(), Skylark_Male::Step(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), Hare_Female::Step(), and TALMaSSObject().

---

The documentation for this class was generated from the following files:

• /builds/ALMaSS/ALMaSS_MIDox/BatchALMaSS/PopulationManager.h
• /builds/ALMaSS/ALMaSS_MIDox/BatchALMaSS/PopulationManager.cpp