Egglib 2.1.11
C++ library reference manual
Public Member Functions | Protected Attributes | List of all members
SingleMigrationRateChange Class Reference

Change of a single migration rate. More...

#include <ChangeTypes.hpp>

Inheritance diagram for SingleMigrationRateChange:
SingleParamChange Change

Public Member Functions

 SingleMigrationRateChange ()
 Default constructor. More...
 
 SingleMigrationRateChange (double date, unsigned int source, unsigned int dest, double migr)
 Standard constructor. More...
 
unsigned source () const
 Gets the source population index.
 
void source (unsigned int)
 Sets the source population index.
 
unsigned dest () const
 Gets the dest population index.
 
void dest (unsigned int)
 Sets the dest population index.
 
void apply (ParamSet *paramSet, Controller *controller) const
 Applies the event. More...
 
- Public Member Functions inherited from SingleParamChange
 SingleParamChange ()
 Default constructor. More...
 
 SingleParamChange (double date, double value)
 Standard constructor. More...
 
double value () const
 Gets the parameter value.
 
void value (double value)
 Sets the parameter value.
 
- Public Member Functions inherited from Change
 Change ()
 Default constructor. More...
 
 Change (double date)
 Standard constructor. More...
 
double date () const
 Gets the event date value.
 
void date (double value)
 Sets the event date value.
 

Protected Attributes

unsigned int _source
 
unsigned int _dest
 
- Protected Attributes inherited from SingleParamChange
double _value
 
- Protected Attributes inherited from Change
double _date
 

Detailed Description

Change of a single migration rate.

Constructor & Destructor Documentation

Default constructor.

The default date is 0., the default parameter value is 0., the default source population is 0, the default destination population 1.

SingleMigrationRateChange ( double  date,
unsigned int  source,
unsigned int  dest,
double  migr 
)

Standard constructor.

Parameters
datethe date of the event.
sourceindex of the source population.
destindex of the destination population.
migrnew value of the pairwise migration rate.

Member Function Documentation

void apply ( ParamSet paramSet,
Controller controller 
) const
virtual

Applies the event.

Parameters
paramSetthe ParamSet instance to which the Change instance is attached.
controllerthe Controller instance of the simulation.

Implements Change.


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

Hosted by 
Get EggLib at SourceForge.net. Fast, secure and Free Open Source software downloads