LCE_StatServiceNotifier Class Reference

Initiates the StatServices' parameters (log time) when registering, calls StatServices::notify() when executing. More...

#include <servicenotifiers.h>

Inheritance diagram for LCE_StatServiceNotifier:

Collaboration diagram for LCE_StatServiceNotifier:

Public Member Functions
	LCE_StatServiceNotifier ()
virtual	~LCE_StatServiceNotifier ()
FileHandler &	getFH ()
bool	setOccurence ()
bool	dummyUpdate ()
virtual bool	setParameters ()
virtual void	execute ()
virtual LCE_StatServiceNotifier *	clone ()
virtual void	loadFileServices (FileServices *loader)
virtual void	loadStatServices (StatServices *loader)
virtual bool	resetParameterFromSource (std::string param, SimComponent *cmpt)
virtual age_t	removeAgeClass ()
virtual age_t	addAgeClass ()
virtual age_t	requiredAgeClass ()
Public Member Functions inherited from LifeCycleEvent
	LifeCycleEvent (const char *name, const char *trait_link)
	Cstor. More...
virtual	~LifeCycleEvent ()
virtual void	init (Metapop *popPtr)
	Sets the pointer to the current Metapop and the trait link if applicable. More...
virtual bool	attach_trait (string trait)
virtual void	set_paramset (std::string name, bool required, SimComponent *owner)
virtual void	set_event_name (std::string &name)
	Set the name of the event (name of the ParamSet) and add the corresponding parameter to the set. More...
virtual void	set_event_name (const char *name)
virtual string &	get_event_name ()
	Accessor to the LCE's name. More...
virtual int	get_rank ()
	Accessor to the LCE rank in the life cycle. More...
virtual void	set_pop_ptr (Metapop *popPtr)
	Accessors for the population pointer. More...
virtual Metapop *	get_pop_ptr ()
Public Member Functions inherited from SimComponent
	SimComponent ()
virtual	~SimComponent ()
virtual void	loadUpdaters (UpdaterServices *loader)
	Loads the parameters and component updater onto the updater manager. More...
virtual void	set_paramset (ParamSet *paramset)
	Sets the ParamSet member. More...
virtual void	set_paramsetFromCopy (const ParamSet &PSet)
	Reset the set of parameters from a another set. More...
virtual ParamSet *	get_paramset ()
	ParamSet accessor. More...
virtual void	add_parameter (Param *param)
	Interface to add a parameter to the set. More...
virtual void	add_parameter (std::string Name, param_t Type, bool isRequired, bool isBounded, double low_bnd, double up_bnd)
	Interface to add a parameter to the set. More...
virtual void	add_parameter (std::string Name, param_t Type, bool isRequired, bool isBounded, double low_bnd, double up_bnd, ParamUpdaterBase *updater)
	Interface to add a parameter and its updater to the set. More...
virtual Param *	get_parameter (std::string name)
	Param getter. More...
virtual double	get_parameter_value (std::string name)
	Param value getter. More...
virtual string	get_name ()
	Returnd the name of the ParamSet, i.e. More...
virtual bool	has_parameter (std::string name)
	Param getter. More...

Private Attributes
StatServices *	_service
unsigned int	_occurrence
string	_arg
string	_dir
LCE_StatFH	_fileHandler

Additional Inherited Members
Protected Attributes inherited from LifeCycleEvent
std::string	_event_name
	The param name to be read in the init file. More...
Metapop *	_popPtr
	The ptr to the current Metapop. More...
std::string	_LCELinkedTraitType
	The name of the linked trait. More...
int	_LCELinkedTraitIndex
	The index in the individual's trait table of the linked trait. More...
Protected Attributes inherited from SimComponent
ParamSet *	_paramSet
	The parameters container. More...

Detailed Description

Initiates the StatServices' parameters (log time) when registering, calls StatServices::notify() when executing.

Registers the file handler used to save the stats to the '.txt' and '_bygen.txt' files.

Constructor & Destructor Documentation

LCE_StatServiceNotifier()

LCE_StatServiceNotifier::LCE_StatServiceNotifier

(

)

: LifeCycleEvent("save_stats",""), _service(0), _occurrence(0)
{
  ParamUpdater<LCE_StatServiceNotifier> * updater;
 
  updater = new ParamUpdater<LCE_StatServiceNotifier> (&LCE_StatServiceNotifier::dummyUpdate);
  
  add_parameter("stat",STR,true,false,0,0);
  
  add_parameter("stat_log_time",INT,true,false,0,0,updater);
  
  add_parameter("stat_dir",STR,false,false,0,0);
  
  add_parameter("stat_output_compact",BOOL,false,false,0,0);
  
  add_parameter("stat_output_CSV",BOOL,false,false,0,0);
  
  add_parameter("stat_output_width",INT,false,false,0,0);
  
  add_parameter("stat_output_precision",INT,false,false,0,0);
  
  add_parameter("stat_output_no_means",BOOL,false,false,0,0);
  
  _service = SIMenv::MainSim->get_StatServices();
}

References _service, SimComponent::add_parameter(), BOOL, dummyUpdate(), SimRunner::get_StatServices(), INT, SIMenv::MainSim, and STR.

Referenced by clone().

~LCE_StatServiceNotifier()

virtual LCE_StatServiceNotifier::~LCE_StatServiceNotifier ( )

inlinevirtual

{ }

Member Function Documentation

addAgeClass()

virtual age_t LCE_StatServiceNotifier::addAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return 0;}

clone()

virtual LCE_StatServiceNotifier* LCE_StatServiceNotifier::clone ( )

inlinevirtual

Implements LifeCycleEvent.

{return new LCE_StatServiceNotifier();}

References LCE_StatServiceNotifier().

dummyUpdate()

bool LCE_StatServiceNotifier::dummyUpdate ( )

inline

{return true;}

Referenced by LCE_StatServiceNotifier().

execute()

void LCE_StatServiceNotifier::execute ( )

virtual

Implements LifeCycleEvent.

{
#ifdef _DEBUG_
  message("LCE_StatServiceNotifier::execute (occurrence %i)\n",_service->getOccurrence());
#endif
  _service->notify();
}

References _service, StatServices::getOccurrence(), message(), and StatServices::notify().

getFH()

FileHandler& LCE_StatServiceNotifier::getFH ( )

inline

{return _fileHandler;}

References _fileHandler.

loadFileServices()

virtual void LCE_StatServiceNotifier::loadFileServices ( FileServices *  loader )

inlinevirtual

Implements SimComponent.

{loader->attach(&_fileHandler);}

References _fileHandler, and FileServices::attach().

loadStatServices()

void LCE_StatServiceNotifier::loadStatServices ( StatServices *  loader )

virtual

Implements SimComponent.

{
//  _service = loader; //already set in cstor
  
  _fileHandler.set_statService(loader);
  
  if(!get_paramset()->isSet())
    error("LCE_StatServiceNotifier::loadStatServices:stat params are not set!\n");
 
  loader->setStatOptions(_arg); //Occurrence has been set previously
  
  if ( _paramSet->isSet("stat_output_no_means") )
    loader->cancelPrintAverages();
  else
    loader->doPrintAverages();
 
}

References _arg, _fileHandler, SimComponent::_paramSet, StatServices::cancelPrintAverages(), StatServices::doPrintAverages(), error(), SimComponent::get_paramset(), ParamSet::isSet(), LCE_StatFH::set_statService(), and StatServices::setStatOptions().

removeAgeClass()

virtual age_t LCE_StatServiceNotifier::removeAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return 0;}

requiredAgeClass()

virtual age_t LCE_StatServiceNotifier::requiredAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return 0;}

resetParameterFromSource()

virtual bool LCE_StatServiceNotifier::resetParameterFromSource ( std::string  param, SimComponent *  cmpt  )

inlinevirtual

Implements SimComponent.

{return false;}

setOccurence()

bool LCE_StatServiceNotifier::setOccurence

(

)

{
  map<unsigned int, unsigned int> atTimes;
  
  Param* logtime = _paramSet->get_param("stat_log_time");
  
  
  if (!(logtime->isMatrix() || logtime->isTemporal())) {
  
    _occurrence = (unsigned int)logtime->getValue();
    
    atTimes[0] = _occurrence;
 
    
  } else if (logtime->isMatrix()) {
    
    
    //a matrix argument may be used to specify a set of generations
    //where results will be saved, it is not recursive
    
    TMatrix tmp;
    logtime->getMatrix(&tmp);
    
    if (tmp.nrows() > 1) {
      fatal("parameter \"stat_log_time\" only accepts one-dimensional arrays.\n");
      return false;
    }
    
    for (unsigned int i = 0; i < tmp.ncols(); ++i)
      atTimes[ tmp.get(0, i) ] = 0; //zero is used to indicate no recursivity
    
    
  } else if (logtime->isTemporal()) {
    
    
    //the occurence time changes during the course of a replicate
    //get the temporal args:
    
    deque< unsigned int > tempoDates = logtime->getUpdatingDates();
    deque< string > tempoArgs = logtime->getTemporalArgs();
    
    for (unsigned int i = 0; i < tempoDates.size(); i++)
      atTimes[ tempoDates[i] ] = tstring::str2int( tempoArgs[i] );
    
  } 
    
  _service->setOccurrences(atTimes);
  
  return true;
}

References _occurrence, SimComponent::_paramSet, _service, fatal(), TMatrix::get(), ParamSet::get_param(), Param::getMatrix(), Param::getTemporalArgs(), Param::getUpdatingDates(), Param::getValue(), Param::isMatrix(), Param::isTemporal(), TMatrix::ncols(), TMatrix::nrows(), StatServices::setOccurrences(), and tstring::str2int().

Referenced by setParameters().

setParameters()

bool LCE_StatServiceNotifier::setParameters ( )

virtual

Implements SimComponent.

{  
  _arg = _paramSet->getArg("stat");
 
  setOccurence();
  
  _dir = _paramSet->getArg("stat_dir");
  
  _fileHandler.set(true, false, 1,
                   SIMenv::getGenerations(), //this is when data is written
                   this->get_rank(),
                   _dir);
  
  //output format:  
  bool is_compact = false;
  if (_paramSet->isSet("stat_output_compact")) {
 
    _service->setCompactOutputFormat();
    is_compact = true;
    
  } else if (_paramSet->isSet("stat_output_CSV")) {
    
    _service->setCompactOutputFormat();
    _service->setFieldSeparator(',');
    is_compact = true;
 
  } else {
    
    _service->setDefaultOutputFormat();
    
  }
 
  if (_paramSet->isSet("stat_output_width") && !is_compact) {
    _service->setFieldWidth((unsigned int)_paramSet->getValue("stat_output_width"));
  }
  
  if (_paramSet->isSet("stat_output_precision")) {
    _service->setFieldPrecision((unsigned int)_paramSet->getValue("stat_output_precision"));
  }
  return true;
}

References _arg, _dir, _fileHandler, SimComponent::_paramSet, _service, LifeCycleEvent::get_rank(), ParamSet::getArg(), SIMenv::getGenerations(), ParamSet::getValue(), ParamSet::isSet(), FileHandler::set(), StatServices::setCompactOutputFormat(), StatServices::setDefaultOutputFormat(), StatServices::setFieldPrecision(), StatServices::setFieldSeparator(), StatServices::setFieldWidth(), and setOccurence().

Member Data Documentation

_arg

string LCE_StatServiceNotifier::_arg

private

Referenced by loadStatServices(), and setParameters().

_dir

string LCE_StatServiceNotifier::_dir

private

Referenced by setParameters().

_fileHandler

LCE_StatFH LCE_StatServiceNotifier::_fileHandler

private

Referenced by getFH(), loadFileServices(), loadStatServices(), and setParameters().

_occurrence

unsigned int LCE_StatServiceNotifier::_occurrence

private

Referenced by setOccurence().

_service

StatServices* LCE_StatServiceNotifier::_service

private

Referenced by execute(), LCE_StatServiceNotifier(), setOccurence(), and setParameters().

---

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

• servicenotifiers.h
• servicenotifiers.cc