StatPopFactory

The class StatPopFactory is derived from the abstract base classs PopulationFactory.

It is used in SimParams to read populations from QDF files and XML files.

A peculiarity of StatPopFactory.cpp code is that it is generated from a template (StatPopFactory.cpp_for_configure) by the script configure.sh The reason for this is to have new statements for all population classes (or a subset thereof, see Alternative Population anf Action directories).

Code:
StatPopFactory.h
StatPopFactory.cpp_template

PublicMethods

constructor

StatPopFactory(SCellGrid *pCG, PopFinder *pPopFinder, int iLayerSize,
               IDGen **apIDG, uint32_t *aulState, uint *aiSeeds)
pCG

The SCellGrid for the current simulation.

pPopFinder

A PopLooper object. Such an object knows all population objects being used in this simulation. Useful for predator-prey relation ships because predators must be able to find their prey.

iLayerSize

Size of the layers of the agent storage (see LayerBuf).

apIDGen

An array of id generators (one for each thread), capable of creating unique ids for agents.

aulState

The initial state for the WELL random number generators`.

aiSeeds

Additional uint s to seed WELL RNGs not used for moving and mating

Initializes the members of StatPopFactory so that they can later be used to create populations.

createPopulationByName

PopBase *createPopulationByName(const std::string sClassName);
sClassName

Name of the class to be created.

Creates a PopBase object corresponding to the provided name (usually called when reading a population from a QDF file).

The big if-else statement used to determine the correct population is generated at compile time:

if (sClassName.empty()) {
    xha_printf("empty Class ID\n");
...
} else if (sClassName == "tut_EnvironAltPop") {
     if (bVerbose) { printf("PopulationFactory is creating tut_EnvironAltPop\n"); }
     pPop = new tut_EnvironAltPop(m_pCG,m_pPopFinder,m_iLayerSize,m_apIDG,m_aulState,m_aiSeeds);
} else if (sClassName == "tut_EnvironCapAltPop") {
...
} else {
    xha_printf("unknown  Class Name [%s]\n", sClassName);
}

readPopulation

virtual PopBase *readPopulation(ParamProvider2 *pPP);
pPP

A ParamProvider2 object

Reads the parameters for a population from pPP and returns a pointer to the population (usually called when reading a population from an xml file).