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 ()
	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...

Detailed Description

The base class of all ALMaSS objects requiring Step code.

Definition at line 109 of file populationmanager.h.

Constructor & Destructor Documentation

TALMaSSObject::TALMaSSObject

(

)

The constructor for TALMaSSObject.

TALMaSSObject Constructor

Definition at line 1449 of file PopulationManager.cpp.

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

TALMaSSObject::~TALMaSSObject ( )

virtual

The destructor for TALMaSSObject.

TALMaSSObject Destructor

Definition at line 1463 of file PopulationManager.cpp.

                              {
#ifdef __CJTDebug_5
  AmAlive = 0;
#endif
}

Member Function Documentation

virtual void TALMaSSObject::BeginStep ( void  )

inlinevirtual

BeingStep behaviour - must be implemented in descendent classes.

Reimplemented in Rabbit_Warren, Rabbit_Base, and TAnimal.

Definition at line 133 of file populationmanager.h.

{}

virtual void TALMaSSObject::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented in Rabbit_Adult, Rabbit_Juvenile, Rabbit_Young, Rabbit_Base, and TAnimal.

Definition at line 137 of file populationmanager.h.

{}

int TALMaSSObject::GetCurrentStateNo ( )

inline

Returns the current state number.

Definition at line 117 of file populationmanager.h.

Referenced by Rabbit_Warren::DEBUG_InternalTest(), Rabbit_Warren::Leave(), CompareStateR::operator()(), CompareStateDead::operator()(), and CompareStateAlive::operator()().

                            {
        return m_CurrentStateNo;
    }

bool TALMaSSObject::GetStepDone ( )

inline

Returns the step done indicator flag.

Definition at line 125 of file populationmanager.h.

                       {
        return m_StepDone;
    }

void TALMaSSObject::OnArrayBoundsError

(

)

Used for debugging only, tests basic object properties.

Definition at line 1497 of file PopulationManager.cpp.

                                       {
  exit( 1 );
}

virtual void TALMaSSObject::ReinitialiseObject ( )

inlinevirtual

Used to re-use an object - must be implemented in descendent classes.

Definition at line 139 of file populationmanager.h.

Referenced by TAnimal::ReinitialiseObject().

                                      {
        m_StepDone = false;
        m_CurrentStateNo = 0;
    }

void TALMaSSObject::SetCurrentStateNo ( int  a_num )

inline

Sets the current state number.

Definition at line 121 of file populationmanager.h.

                                      {
        m_CurrentStateNo = a_num;
    }

void TALMaSSObject::SetStepDone ( bool  a_bool )

inline

Sets the step done indicator flag.

Definition at line 129 of file populationmanager.h.

                                  {
        m_StepDone = a_bool;
    }

virtual void TALMaSSObject::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented in Rabbit_Warren, Rabbit_Female, Rabbit_Male, Rabbit_Juvenile, Rabbit_Young, Rabbit_Base, and TAnimal.

Definition at line 135 of file populationmanager.h.

{}

Member Data Documentation

int TALMaSSObject::m_CurrentStateNo

protected

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

Definition at line 112 of file populationmanager.h.

Referenced by Rabbit_Juvenile::EndStep(), Rabbit_Adult::EndStep(), Rabbit_Base::st_Dying(), Rabbit_Young::st_Dying(), Rabbit_Juvenile::st_Dying(), Rabbit_Adult::st_Dying(), Rabbit_Young::Step(), Rabbit_Juvenile::Step(), Rabbit_Male::Step(), Rabbit_Female::Step(), and Rabbit_Warren::Step().

bool TALMaSSObject::m_StepDone

protected

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

Definition at line 114 of file populationmanager.h.

Referenced by Rabbit_Base::GeneralOrganoPhosphate(), Rabbit_Base::st_Dying(), Rabbit_Young::st_Dying(), Rabbit_Juvenile::st_Dying(), Rabbit_Adult::st_Dying(), Rabbit_Female::st_EvaluateTerritory(), Rabbit_Young::Step(), Rabbit_Juvenile::Step(), Rabbit_Male::Step(), Rabbit_Female::Step(), and Rabbit_Warren::Step().

---

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

• D:/CJT/Repos/ALMaSS_all/BatchALMaSS/populationmanager.h
• D:/CJT/Repos/ALMaSS_all/BatchALMaSS/PopulationManager.cpp