StatHandlerBase Class Reference

Base class of the StatHandler class, implements the Handler interface. More...

#include <stathandler.h>

Inheritance diagram for StatHandlerBase:

Collaboration diagram for StatHandlerBase:

Public Member Functions
	StatHandlerBase ()
virtual	~StatHandlerBase ()
virtual void	reset ()
	Empties the _stats list and calls clear() (defined in the derived class). More...
Accessors
Metapop *	get_pop_ptr ()
void	set_service (StatServices *srv)
StatServices *	get_service ()
unsigned int	getOccurrence ()
unsigned int	getNumOccurrences ()
unsigned int	getCurrentOccurrence ()
unsigned int	getNbRecorders ()
std::list< StatRecBase * > &	getStats ()
virtual void	add (StatRecBase *rec)
Handler implementation
virtual void	init ()
virtual void	update ()
	This function is left empty as the StatServices calls StatRecorder::setVal directly. More...
StatHandler interface declaration
virtual bool	setStatRecorders (std::string &token)=0
virtual void	clear ()=0
Public Member Functions inherited from Handler
virtual	~Handler ()

Protected Attributes
Metapop *	_pop
	Link to the current population, set through the link to the StatService. More...

Private Types
typedef std::list< StatRecBase * >::iterator	STAT_IT

Private Attributes
std::list< StatRecBase * >	_stats
	Link to the StatRecorder list elements in the StatHandler derived class. More...
StatServices *	_service
	Link to the StatService. More...

Detailed Description

Base class of the StatHandler class, implements the Handler interface.

This class stores the Handler state and the list of links to the StatRecBase. This list is duplicated in the StatHandler as a list of the StatRecorder templates. It allows the StatService to access the stat recorders without knowledge of the actual StatHandler and StatRecorder template type.

Member Typedef Documentation

STAT_IT

typedef std::list< StatRecBase* >::iterator StatHandlerBase::STAT_IT

private

Constructor & Destructor Documentation

StatHandlerBase()

StatHandlerBase::StatHandlerBase ( )

inline

:  _service(0) {}

~StatHandlerBase()

virtual StatHandlerBase::~StatHandlerBase ( )

inlinevirtual

{ }

Member Function Documentation

add()

virtual void StatHandlerBase::add ( StatRecBase *  rec )

inlinevirtual

{_stats.push_back(rec);}

References _stats.

Referenced by StatHandler< SH >::add().

clear()

virtual void StatHandlerBase::clear ( )

pure virtual

Implemented in StatHandler< SH >, StatHandler< MPStatHandler >, and StatHandler< TTDispersalSH >.

Referenced by reset().

get_pop_ptr()

Metapop* StatHandlerBase::get_pop_ptr ( )

inline

{return _service->get_pop_ptr();}

References _service, and StatServices::get_pop_ptr().

Referenced by init().

get_service()

StatServices* StatHandlerBase::get_service ( )

inline

{return _service;}

References _service.

getCurrentOccurrence()

unsigned int StatHandlerBase::getCurrentOccurrence ( )

inline

{return _service->getCurrentOccurrence();}

References _service, and StatServices::getCurrentOccurrence().

getNbRecorders()

unsigned int StatHandlerBase::getNbRecorders ( )

inline

{return _stats.size();}

References _stats.

getNumOccurrences()

unsigned int StatHandlerBase::getNumOccurrences ( )

inline

{return _service->getNumOccurrences();}

References _service, and StatServices::getNumOccurrences().

getOccurrence()

unsigned int StatHandlerBase::getOccurrence ( )

inline

{return _service->getOccurrence();}

References _service, and StatServices::getOccurrence().

getStats()

std::list<StatRecBase*>& StatHandlerBase::getStats ( )

inline

{return _stats;}

References _stats.

init()

void StatHandlerBase::init ( )

virtual

Implements Handler.

Reimplemented in TTQuantiSH, TTNeutralGenesSH, and TTDispersalSH.

{
  _pop = get_pop_ptr();
 
  if(SIMenv::getGenerations() == 0)
    fatal("cannot initialize stat recorders, generation nbr is null\n");
  
  if(SIMenv::getReplicates() == 0) 
    fatal("cannot initialize stat recorders, replicate nbr is null\n");
 
}

References _pop, fatal(), get_pop_ptr(), SIMenv::getGenerations(), and SIMenv::getReplicates().

Referenced by TTDispersalSH::init(), TTNeutralGenesSH::init(), and TTQuantiSH::init().

reset()

void StatHandlerBase::reset ( )

virtual

Empties the _stats list and calls clear() (defined in the derived class).

{
  STAT_IT IT = _stats.begin();
 
  while(IT != _stats.end()) {
    delete (*IT);
    IT++;
  }
 
  _stats.clear();
  
  clear();
}

References _stats, and clear().

set_service()

void StatHandlerBase::set_service ( StatServices *  srv )

inline

{_service = srv;}

References _service.

Referenced by StatServices::attach().

setStatRecorders()

virtual bool StatHandlerBase::setStatRecorders ( std::string &  token )

pure virtual

Implemented in TTWolbachiaSH, LCE_SelectionSH, TTQuantiSH, TTNeutralGenesSH, TTDispersalSH, TTDeletMutBitstrSH, TTBDMI_SH, and MPStatHandler.

update()

virtual void StatHandlerBase::update ( )

inlinevirtual

This function is left empty as the StatServices calls StatRecorder::setVal directly.

Implements Handler.

{ }

Member Data Documentation

_pop

Metapop* StatHandlerBase::_pop

protected

Link to the current population, set through the link to the StatService.

Referenced by TTQuantiSH::addAvgPerPatch(), TTQuantiSH::addCovarPerPatch(), TTDispersalSH::addDispPerPatch(), TTQuantiSH::addEigenPerPatch(), TTQuantiSH::addEigenValuesPerPatch(), TTQuantiSH::addEigenVect1PerPatch(), TTQuantiSH::addGenotPerPatch(), MPStatHandler::addIndNumPerPatch(), LCE_SelectionSH::addMeanPerPatch(), MPStatHandler::addPatchAge(), TTQuantiSH::addQuanti(), TTQuantiSH::addSkewPerPatch(), TTBDMI_SH::addStats(), LCE_SelectionSH::addVarPerPatch(), TTQuantiSH::addVarPerPatch(), TTNeutralGenesSH::allocateTables(), TTNeutralGenesSH::getDxy(), TTNeutralGenesSH::getDxyPerPatch(), TTDeletMutBitstrSH::getLoad(), TTDispersalSH::getMeanDispRate(), TTDispersalSH::getMeanDispRateInPatch(), TTDeletMutBitstrSH::getMeanFecWithPatchMate(), TTWolbachiaSH::getMeanFemaleInfection_perPatch(), TTDispersalSH::getMeanFemDispRate(), TTDispersalSH::getMeanMalDispRate(), TTWolbachiaSH::getMeanMaleInfection_perPatch(), TTWolbachiaSH::getMeanOffsprgFemaleInfection_perPatch(), TTWolbachiaSH::getMeanOffsprgInfection(), TTWolbachiaSH::getMeanOffsprgMaleInfection_perPatch(), LCE_SelectionSH::getMeanPatchFitness(), TTDispersalSH::getOffsprgMeanDispRate(), TTDeletMutBitstrSH::getPatchLoad(), LCE_SelectionSH::getVarPatchFitness(), init(), TTDispersalSH::init(), TTQuantiSH::init(), TTNeutralGenesSH::setAlleleTables(), TTNeutralGenesSH::setCoaMatrixRecorders(), LCE_SelectionSH::setDataTable(), TTQuantiSH::setDataTables(), TTDeletMutBitstrSH::setDeletStats(), TTNeutralGenesSH::setDxyRecorders(), TTDeletMutBitstrSH::setFst(), TTNeutralGenesSH::setFst_li(), TTNeutralGenesSH::setFstat(), TTNeutralGenesSH::setFstat2(), TTNeutralGenesSH::setFstatWeirCockerham(), TTNeutralGenesSH::setFstatWeirCockerham_MS(), TTNeutralGenesSH::setFstMatrix(), TTNeutralGenesSH::setFstMatrixRecorders(), TTNeutralGenesSH::setHeteroTable(), TTNeutralGenesSH::setHeterozygosity(), TTNeutralGenesSH::setHo(), TTNeutralGenesSH::setHo2(), TTNeutralGenesSH::setHs(), TTNeutralGenesSH::setHs2(), TTWolbachiaSH::setInfectionStats(), TTDeletMutBitstrSH::setLethalEquivalents(), TTNeutralGenesSH::setLociDivCounter(), TTDeletMutBitstrSH::setMeanViability(), TTNeutralGenesSH::setNeiGeneticDistance(), TTNeutralGenesSH::setNeiGeneticDistanceRecorders(), TTWolbachiaSH::setStatRecorders(), TTBDMI_SH::setStats(), TTQuantiSH::setStats(), MPStatHandler::setStatsForMigrantsPerPatch(), and TTDeletMutBitstrSH::setViability().

_service

StatServices* StatHandlerBase::_service

private

Link to the StatService.

Referenced by get_pop_ptr(), get_service(), getCurrentOccurrence(), getNumOccurrences(), getOccurrence(), and set_service().

_stats

std::list<StatRecBase*> StatHandlerBase::_stats

private

Link to the StatRecorder list elements in the StatHandler derived class.

Referenced by add(), getNbRecorders(), getStats(), and reset().

---

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

• stathandler.h
• stathandler.cc