SimBuilder Class Reference

Provides methods to build the user's selected set of life cycle events and traits from the parameters. More...

#include <basicsimulation.h>

Inheritance diagram for SimBuilder:

Collaboration diagram for SimBuilder:

Public Member Functions
	SimBuilder ()
	SimBuilder (const SimBuilder &SB)
	copy cstor. More...
	~SimBuilder ()
bool	build_currentParams (map< string, string > &simparams)
	Builds the list of parameters from user's defined input parameters. More...
map< trait_t, TraitPrototype * > &	build_currentTraits ()
	Selects the trait prototypes that have their parameters set. More...
void	build_LifeCycle ()
	Selects the life cycle events that have their parameters set. More...
TraitPrototype *	get_current_trait (trait_t type)
	Accessor to the list of current trait prototypes. More...
TraitPrototype *	get_current_traitWithParameter (string &param)
	Accessor to the current trait prototypes conditioned on ownership of a specified parameter. More...
LifeCycleEvent *	get_current_event (string &name)
	Accessor to the list of current LCEs. More...
LifeCycleEvent *	get_current_eventWithParameter (string &param)
	Accessor to the current LCEs conditioned on ownership of a specified parameter. More...
list< ParamSet * > &	get_currentParams ()
	Accessor to the list of the selected parameter sets. More...
age_t	getFirstRequiredAgeInLifeCycle ()
Public Member Functions inherited from ParamManager
	ParamManager ()
	Cstor. More...
	~ParamManager ()
void	add_paramset (ParamSet *paramset)
	Adds a ParamSet to the list of the parameter sets of the simulation. More...
ParamSet *	get_paramset (string &name)
	Looks for paramset with "name" in the list of parameter sets. More...
void	build_allParams ()
	Clears and fills the _allParams list with the ParamSet's of the simulation components. More...
list< ParamSet * > &	get_allParams ()
	Accessor of the whole list of the parameter sets. More...
bool	set_parameters (map< string, string > &simparams, bool silent)
	Sets the parameters of the simulation with the argument strings given in input. More...
bool	param_consistency_check ()
	Checks if all the mandatory parameters are set so that the simulation can be launched. More...
void	build_records (map< string, vector< string > > &initParams)
	Builds the list of simulation parameters from the parsed input file(s). More...
list< map< string, string > > &	get_simRecords ()
	Accessor to the simulations parameter list. More...
map< string, string > &	get_firstRecord ()
	Accessor to the first element in the simulations parameter list. More...
int	get_nbSims ()
	Accessor to the size of the simulations parameter list, i.e. More...
Public Member Functions inherited from ComponentManager
	ComponentManager ()
	~ComponentManager ()
void	build_component_list ()
	Clears and builds the list of all components from the lists of trait prototype templates and life cycle event templates. More...
void	add_component (SimComponent *cmpt)
	Push a component at the back of the component list. More...
void	add_trait (TraitPrototype *trait)
	Add a trait prototype to the template and component lists. More...
void	add_LCE (LifeCycleEvent *event)
	Add a life cycle event to the template and component lists. More...
TraitPrototype *	get_trait (string name)
	Search for component with "name" in the trait prototype list. More...
LifeCycleEvent *	get_LCE (string name)
	Search for component with "name" in the life cycle events list. More...

Protected Types
typedef map< int, LifeCycleEvent * >::const_iterator	LCE_ITER
typedef map< trait_t, TraitPrototype * >::const_iterator	TRAIT_ITER

Protected Attributes
list< ParamSet * >	_currentParams
	List of the selected simulation components from the user defined input parameters. More...
map< trait_t, TraitPrototype * >	_currentTraits
	List of the selected trait prototypes from the user defined input parameters. More...
map< int, LifeCycleEvent * >	_LifeCycle
	List of the selected life cycle events from the user defined input parameters. More...
Protected Attributes inherited from ParamManager
list< ParamSet * >	_allParams
	A list of all the parameter sets of all the simulation components loaded in the _component list of the ComponentManager. More...
map< string, string >	_inputParams
	A map of the parameters and their arguments of the current (running) simulation. More...
map< unsigned int, list< pair< string, string > > >	_temporalParams
	Lists of parameters to be updated during a simulation indexed by generation update time. More...
list< map< string, string > >	_simRecords
	Sets of parameters of all the simulations to perform. More...
ParamSet	_paramSet
	The ParamSet param set of the simulation. More...
Protected Attributes inherited from ComponentManager
list< SimComponent * >	_components
	List of all the simulation components. More...
list< TraitPrototype * >	_TTrait_Templates
	List of all trait prototypes of the simulation, a subset of _components list. More...
list< LifeCycleEvent * >	_LCE_Templates
	List of all the life-cycle events of the simulation, a subset of _components list. More...

Detailed Description

Provides methods to build the user's selected set of life cycle events and traits from the parameters.

This class implements methods to build the lists of selected traits and life cycle events from the user's defined parameters. Each simulation component that has its ParamSet in the "set" state is elligible to be part of the current simulation. Accessors to these components are provided. This class does however not provide a runnable simulation object.

Member Typedef Documentation

LCE_ITER

typedef map< int, LifeCycleEvent* >::const_iterator SimBuilder::LCE_ITER

protected

TRAIT_ITER

typedef map< trait_t, TraitPrototype* >::const_iterator SimBuilder::TRAIT_ITER

protected

Constructor & Destructor Documentation

SimBuilder() [1/2]

SimBuilder::SimBuilder ( )

inline

{ }

SimBuilder() [2/2]

SimBuilder::SimBuilder

(

const SimBuilder &

SB

)

copy cstor.

{  
  list< TraitPrototype* >::const_iterator TT = SB._TTrait_Templates.begin();
  
  for(;TT != SB._TTrait_Templates.end(); TT++)  add_trait( (*TT)->clone() );
  
  list< LifeCycleEvent* >::const_iterator LCE = SB._LCE_Templates.begin();
  
  for(;LCE != SB._LCE_Templates.end(); LCE++)   add_LCE( (*LCE)->clone() );
    
  
  _paramSet = SB._paramSet;
  
  build_allParams();
}

References ComponentManager::_LCE_Templates, ParamManager::_paramSet, ComponentManager::_TTrait_Templates, ComponentManager::add_LCE(), ComponentManager::add_trait(), and ParamManager::build_allParams().

~SimBuilder()

SimBuilder::~SimBuilder

(

)

{
#ifdef _DEBUG_
  message("SimBuilder::~SimBuilder\n");
#endif
  
  _components.clear();
  
  list< TraitPrototype* >::iterator TT_it = _TTrait_Templates.begin();
  
  while(TT_it != _TTrait_Templates.end()) {
    delete (*TT_it);
    TT_it++;
  }
  
  list< LifeCycleEvent* >::iterator LCE_it = _LCE_Templates.begin();
  
  while(LCE_it != _LCE_Templates.end()) {
    delete (*LCE_it);
    LCE_it++;
  }
    
}

References ComponentManager::_components, ComponentManager::_LCE_Templates, ComponentManager::_TTrait_Templates, and message().

Member Function Documentation

build_currentParams()

bool SimBuilder::build_currentParams

(

map< string, string > &

simparams

)

Builds the list of parameters from user's defined input parameters.

Parameters

simparams

Hashtable of the parsed input parameters

Returns

TRUE if parameters are consitently set

{
  if(! this->set_parameters(simparams, false) ) return false;
  
  //empty the current parameters container:
  _currentParams.clear();
  
  list<ParamSet*>::iterator current_paramset = this->_allParams.begin();
  
  //add all set parameters to the list of the current params:
  while(current_paramset != this->_allParams.end()){
    if((*current_paramset)->isSet()) {
#ifdef _DEBUG_
      message("SimBuilder::build_currentParams:adding paramset %s\n",
              (*current_paramset)->getName().c_str());
#endif
      _currentParams.push_back(*current_paramset);
    }
    current_paramset++;
  }
  
  return true;
}

References ParamManager::_allParams, _currentParams, message(), and ParamManager::set_parameters().

Referenced by BinaryDataLoader::extractPop(), and SimRunner::init_components().

Here is the caller graph for this function:

build_currentTraits()

map< trait_t, TraitPrototype * > & SimBuilder::build_currentTraits

(

)

Selects the trait prototypes that have their parameters set.

Returns

Hashtable of the trait prototypes

{
  //build the list of Traits for this simulation:
  list< TraitPrototype* >::iterator trait = this->_TTrait_Templates.begin();
  
  _currentTraits.clear();
  
  while(trait != this->_TTrait_Templates.end()) {
    
    if( (*trait)->get_paramset()->isSet() ){
      _currentTraits[(*trait)->get_type()] = (*trait);
    }
    
    trait++;
  }
  
  return _currentTraits;
}

References _currentTraits, and ComponentManager::_TTrait_Templates.

Referenced by BinaryDataLoader::extractPop(), and SimRunner::init_components().

Here is the caller graph for this function:

build_LifeCycle()

void SimBuilder::build_LifeCycle

(

)

Selects the life cycle events that have their parameters set.

{
  //build the list of the life cycle events for this simulation:
  list< LifeCycleEvent* >::iterator LCE = this->_LCE_Templates.begin();
  
  _LifeCycle.clear();
  
  int rank;
 
  
  while(LCE != this->_LCE_Templates.end()) {
 
    if( (*LCE)->get_paramset()->isSet() ){
 
#ifdef _DEBUG_
      cout <<"adding LCE "<< (*LCE)->get_event_name() <<" : "<< (*LCE)->get_rank() << endl;
#endif
 
      rank = (int)(*LCE)->get_rank();
 
      if(rank < 0)
        fatal("rank %i for LCE \"%s\" cannot be negative, please provide a positive rank number.\n", rank, (*LCE)->get_name().c_str());
 
      if(_LifeCycle[rank]){
        fatal("rank %i for LCE \"%s\" is already assigned to \"%s\", please choose a different rank number.\n",
            rank, (*LCE)->get_name().c_str(), _LifeCycle[rank]->get_name().c_str());
      }
      else
        _LifeCycle[rank] = (*LCE);
    }
    LCE++;
  }
 
}

References ComponentManager::_LCE_Templates, _LifeCycle, and fatal().

Referenced by SimRunner::setLifeCycle().

Here is the caller graph for this function:

get_current_event()

LifeCycleEvent * SimBuilder::get_current_event

(

string &

name

)

Accessor to the list of current LCEs.

Parameters

name	the name of the LCE

Returns

ptr to the LCE

{
  LCE_ITER LCE = _LifeCycle.begin();
  
  while(LCE != _LifeCycle.end()) {
    if( LCE->second->get_event_name().compare(name) == 0)
      return LCE->second;
    LCE++;
  }
  
  return NULL;
}

References _LifeCycle.

Referenced by Metapop::loadPopFromBinarySource(), and SimRunner::run_event().

Here is the caller graph for this function:

get_current_eventWithParameter()

LifeCycleEvent * SimBuilder::get_current_eventWithParameter

(

string &

param

)

Accessor to the current LCEs conditioned on ownership of a specified parameter.

Parameters

the	name of the parameter of interest

Returns

a pointer to the LCE, is NULL if no trait found

{
   LifeCycleEvent* event = NULL;
 
  for(LCE_ITER LCE = _LifeCycle.begin(); LCE != _LifeCycle.end(); LCE++)
  {
    if( LCE->second->has_parameter(param)) {
      event = LCE->second;
      break;  //this assumes that parameters are unique, the first component found with that parameter is returned
    }
  }
 
  return event;
}

References _LifeCycle.

Referenced by Metapop::loadPopFromBinarySource().

Here is the caller graph for this function:

get_current_trait()

TraitPrototype * SimBuilder::get_current_trait

(

trait_t

type

)

Accessor to the list of current trait prototypes.

Parameters

type	the trait type

Returns

ptr to the prototype

{
  TRAIT_ITER trait = _currentTraits.find(type);
  
  if(trait != _currentTraits.end())
    return trait->second;
  else
    return NULL;
}

References _currentTraits.

Referenced by Metapop::loadPopFromBinarySource().

Here is the caller graph for this function:

get_current_traitWithParameter()

TraitPrototype * SimBuilder::get_current_traitWithParameter

(

string &

param

)

Accessor to the current trait prototypes conditioned on ownership of a specified parameter.

Parameters

the	name of the parameter of interest

Returns

a pointer to the trait prototype, is NULL if no trait found

{
   TraitPrototype* TP = NULL;
 
  for(TRAIT_ITER trait = _currentTraits.begin(); trait != _currentTraits.end(); trait++)
  {
    if( trait->second->has_parameter(param)) {
      TP = trait->second;
      break;  //this assumes that parameters are unique, the first component found with that parameter is returned
    }
  }
 
  return TP;
}

References _currentTraits.

Referenced by Metapop::loadPopFromBinarySource().

Here is the caller graph for this function:

get_currentParams()

list<ParamSet*>& SimBuilder::get_currentParams ( )

inline

Accessor to the list of the selected parameter sets.

Returns

list of ParamSet

{return _currentParams;}

Referenced by SimRunner::expandPreservedMacros().

Here is the caller graph for this function:

getFirstRequiredAgeInLifeCycle()

age_t SimBuilder::getFirstRequiredAgeInLifeCycle

(

)

{
  age_t requiredAgeClass = NONE;
 
  for(LCE_ITER IT = _LifeCycle.begin();
      IT != _LifeCycle.end() && requiredAgeClass == NONE;
      IT++)
    requiredAgeClass = IT->second->requiredAgeClass();
  
  return requiredAgeClass;
}

References _LifeCycle, and NONE.

Referenced by Metapop::setPopulation().

Here is the caller graph for this function:

Member Data Documentation

_currentParams

list< ParamSet* > SimBuilder::_currentParams

protected

List of the selected simulation components from the user defined input parameters.

Referenced by build_currentParams().

_currentTraits

map< trait_t, TraitPrototype* > SimBuilder::_currentTraits

protected

List of the selected trait prototypes from the user defined input parameters.

Referenced by build_currentTraits(), get_current_trait(), get_current_traitWithParameter(), SimRunner::register_component_handlers(), and SimRunner::run().

_LifeCycle

map< int, LifeCycleEvent* > SimBuilder::_LifeCycle

protected

List of the selected life cycle events from the user defined input parameters.

Referenced by build_LifeCycle(), get_current_event(), get_current_eventWithParameter(), getFirstRequiredAgeInLifeCycle(), SimRunner::init_components(), SimRunner::register_component_handlers(), SimRunner::run(), SimRunner::setLifeCycle(), and SimRunner::step().

---

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

• basicsimulation.h
• basicsimulation.cc