Nemo  2.3.56
Simulate forward-in-time genetic evolution in a spatially explicit, individual-based stochastic simulator
ParamUpdaterBase Class Referenceabstract

Base class of the ParamUpdater class used to handle the temporal parameter argument values. More...

#include <param.h>

+ Inheritance diagram for ParamUpdaterBase:
+ Collaboration diagram for ParamUpdaterBase:

Public Types

typedef list< Param * >::iterator PIT
 

Public Member Functions

 ParamUpdaterBase ()
 
 ParamUpdaterBase (const ParamUpdaterBase &PU)
 
virtual ~ParamUpdaterBase ()
 
virtual void init ()=0
 
virtual void update ()
 
virtual bool update (unsigned int generation)=0
 Updating procedure. More...
 
virtual SimComponentgetComponent ()=0
 
virtual void addParam (Param *param)
 Adds a parameter to the stack. More...
 
virtual void reset ()
 Clears the parameters stack. More...
 
list< Param * > getParams ()
 Returns the list of parameters. More...
 
- Public Member Functions inherited from Handler
virtual void init ()=0
 Inits state. More...
 
virtual void update ()=0
 Updates the handler state. More...
 
virtual ~Handler ()
 

Protected Attributes

list< Param * > _params
 List of the parameters affected by this updater. More...
 

Detailed Description

Base class of the ParamUpdater class used to handle the temporal parameter argument values.

Member Typedef Documentation

◆ PIT

typedef list<Param*>::iterator ParamUpdaterBase::PIT

Constructor & Destructor Documentation

◆ ParamUpdaterBase() [1/2]

ParamUpdaterBase::ParamUpdaterBase ( )
inline
327{ }

◆ ParamUpdaterBase() [2/2]

ParamUpdaterBase::ParamUpdaterBase ( const ParamUpdaterBase PU)
inline
330 {
331 _params.assign(PU._params.begin(), PU._params.end());
332 }
list< Param * > _params
List of the parameters affected by this updater.
Definition: param.h:319

References _params.

◆ ~ParamUpdaterBase()

virtual ParamUpdaterBase::~ParamUpdaterBase ( )
inlinevirtual
334{}

Member Function Documentation

◆ addParam()

virtual void ParamUpdaterBase::addParam ( Param param)
inlinevirtual

Adds a parameter to the stack.

343{_params.push_back( param );}

References _params.

Referenced by ParamSet::add_param().

+ Here is the caller graph for this function:

◆ getComponent()

virtual SimComponent * ParamUpdaterBase::getComponent ( )
pure virtual

Implemented in ParamUpdater< SC >.

◆ getParams()

list< Param * > ParamUpdaterBase::getParams ( )
inline

Returns the list of parameters.

347{return _params;}

References _params.

Referenced by UpdaterServices::attach().

+ Here is the caller graph for this function:

◆ init()

virtual void ParamUpdaterBase::init ( )
pure virtual

Implements Handler.

Implemented in ParamUpdater< SC >.

◆ reset()

virtual void ParamUpdaterBase::reset ( )
inlinevirtual

Clears the parameters stack.

345{_params.clear();}

References _params.

◆ update() [1/2]

virtual void ParamUpdaterBase::update ( )
inlinevirtual

Implements Handler.

337{}

◆ update() [2/2]

virtual bool ParamUpdaterBase::update ( unsigned int  generation)
pure virtual

Updating procedure.

Implemented in ParamUpdater< SC >.

Member Data Documentation

◆ _params

list< Param* > ParamUpdaterBase::_params
protected

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

Generated for Nemo v2.3.56 by  doxygen 1.9.0 -- Nemo is hosted on  Download Nemo

Locations of visitors to this page
Catalogued on GSR