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

Bottleneck event. More...

#include <ChangeTypes.hpp>

Inheritance diagram for Bottleneck:
SingleParamChange Change

Public Member Functions

 Bottleneck (double date, double param)
 
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.
 

Additional Inherited Members

- Protected Attributes inherited from SingleParamChange
double _value
 
- Protected Attributes inherited from Change
double _date
 

Detailed Description

Bottleneck event.

The bottleneck parameter is its strength, corresponding to an amount of time where time is locked and only coalescences are allowed (resulting in a given - and random - number of instantaneous coalescence with branches).

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