TALMaSSObject Class Reference

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

Detailed Description

The base class of all ALMaSS objects requiring Step code.

Constructor & Destructor Documentation

TALMaSSObject::TALMaSSObject

(

)

The constructor for TALMaSSObject.

TALMaSSObject Constructor

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

TALMaSSObject::~TALMaSSObject ( )

virtual

The destructor for TALMaSSObject.

TALMaSSObject Destructor

                              {
#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 TAnimal.

{}

virtual void TALMaSSObject::EndStep ( void  )

inlinevirtual

EndStep behaviour - must be implemented in descendent classes.

Reimplemented in TAnimal.

{}

int TALMaSSObject::GetCurrentStateNo ( )

inline

Returns the current state number.

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

                                {
                return m_CurrentStateNo;
        }

bool TALMaSSObject::GetStepDone ( )

inline

Returns the step done indicator flag.

                           {
                return m_StepDone;
        }

void TALMaSSObject::OnArrayBoundsError

(

)

Used for debugging only, tests basic object properties.

                                       {
  exit( 1 );
}

virtual void TALMaSSObject::ReinitialiseObject ( )

inlinevirtual

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

Referenced by TAnimal::ReinitialiseObject().

                                          {
                m_StepDone = false;
                m_CurrentStateNo = 0;
        }

void TALMaSSObject::SetCurrentStateNo ( int  a_num )

inline

Sets the current state number.

                                          {
                m_CurrentStateNo = a_num;
        }

void TALMaSSObject::SetStepDone ( bool  a_bool )

inline

Sets the step done indicator flag.

                                      {
                m_StepDone = a_bool;
        }

virtual void TALMaSSObject::Step ( void  )

inlinevirtual

Step behaviour - must be implemented in descendent classes.

Reimplemented in TAnimal.

{}

Member Data Documentation

int TALMaSSObject::m_CurrentStateNo

protected

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

bool TALMaSSObject::m_StepDone

protected

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

---

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

• PopulationManager.h
• PopulationManager.cpp