LCE_Regulation Class Reference

Regulates the patches to their carrying capacity, acts on each age class separately. More...

#include <LCEmisc.h>

Inheritance diagram for LCE_Regulation:

Collaboration diagram for LCE_Regulation:

Public Member Functions
	LCE_Regulation ()
virtual	~LCE_Regulation ()
void	regulatePatch (Patch *patch, age_idx age, sex_t sex)
virtual bool	setParameters ()
virtual void	execute ()
virtual LCE_Regulation *	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...

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

Regulates the patches to their carrying capacity, acts on each age class separately.

Randomly removes individuals in each patch until each age class has reached the (sex-specific) carrying capacities of the patch.

Constructor & Destructor Documentation

LCE_Regulation()

LCE_Regulation::LCE_Regulation ( )

inline

: LifeCycleEvent("regulation","") {}

Referenced by clone().

~LCE_Regulation()

virtual LCE_Regulation::~LCE_Regulation ( )

inlinevirtual

{ }

Member Function Documentation

addAgeClass()

virtual age_t LCE_Regulation::addAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return NONE;}

References NONE.

clone()

virtual LCE_Regulation* LCE_Regulation::clone ( )

inlinevirtual

Implements LifeCycleEvent.

{return new LCE_Regulation();}

References LCE_Regulation().

execute()

void LCE_Regulation::execute ( )

virtual

Implements LifeCycleEvent.

{
#ifdef _DEBUG_
  message("LCE_Regulation::execute (Patch nb: %i, offsprg: %i, adults: %i ",_popPtr->getPatchNbr()
          ,_popPtr->size( OFFSPRG ), _popPtr->size( ADULTS ));
#endif
  Patch* patch;
  
  for(unsigned int i = 0; i < _popPtr->getPatchNbr(); i ++) {
    
    patch = _popPtr->getPatch(i);
    
    regulatePatch(patch, OFFSx, FEM);
    regulatePatch(patch, OFFSx, MAL);
    regulatePatch(patch, ADLTx, FEM);
    regulatePatch(patch, ADLTx, MAL);
    
  }
  
#ifdef _DEBUG_
  message("after: offsprg: %i, adults: %i)\n",_popPtr->size( OFFSPRG ), _popPtr->size( ADULTS ));
#endif
  
}

References LifeCycleEvent::_popPtr, ADLTx, ADULTS, FEM, Metapop::getPatch(), Metapop::getPatchNbr(), MAL, message(), OFFSPRG, OFFSx, regulatePatch(), and Metapop::size().

loadFileServices()

virtual void LCE_Regulation::loadFileServices ( FileServices *  loader )

inlinevirtual

Implements SimComponent.

{}

loadStatServices()

virtual void LCE_Regulation::loadStatServices ( StatServices *  loader )

inlinevirtual

Implements SimComponent.

{}

regulatePatch()

void LCE_Regulation::regulatePatch	(	Patch *	patch,
		age_idx	age,
		sex_t	sex
	)

{
  unsigned int K = patch->get_K(sex);
  
  while( patch->size(sex, age) > K ) 
    _popPtr->recycle( patch->remove(sex, age, RAND::Uniform( patch->size(sex, age) ) ) );
}

References LifeCycleEvent::_popPtr, Patch::get_K(), IndFactory::recycle(), Patch::remove(), Patch::size(), and RAND::Uniform().

Referenced by execute().

removeAgeClass()

virtual age_t LCE_Regulation::removeAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return NONE;}

References NONE.

requiredAgeClass()

virtual age_t LCE_Regulation::requiredAgeClass ( )

inlinevirtual

Implements LifeCycleEvent.

{return NONE;}

References NONE.

resetParameterFromSource()

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

inlinevirtual

Implements SimComponent.

{return false;}

setParameters()

virtual bool LCE_Regulation::setParameters ( )

inlinevirtual

Implements SimComponent.

{return true;}

---

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

• LCEmisc.h
• LCEmisc.cc