Migration Class Reference

Migration class - handles individual migration between demes. More...

#include <Migration.h>

Inheritance diagram for Migration:

Public Member Functions
bool	operate (StateP)
bool	initialize (StateP)
	Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used! More...
void	registerParameters (StateP)
	Register parameters with the Registry. Called before Operator::initialize. More...
Public Member Functions inherited from Operator
virtual bool	operate (StateP)=0
	perform the designated operation More...
virtual bool	initialize (StateP)
	Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used! More...
virtual void	registerParameters (StateP)
	Register parameters with the Registry. Called before Operator::initialize. More...
virtual void	write (XMLNode &)
	Write operator state to XMLNode or the Registry. Called after Operator::initialize. More...
virtual void	read (XMLNode &)
	Read operator state from XMLNode or the Registry. Called after Operator::initialize. More...

Protected Attributes
StateP	state_
uint	migFrequency_
uint	nEmigrants_
std::vector< SelectionOperatorP >	selOp_

Static Protected Attributes
static const int	BEST = 0
static const int	RANDOM = 1

Detailed Description

Migration class - handles individual migration between demes.

Note: will be reimplemented to allow proprietary user-defined migration criteria.

Definition at line 10 of file Migration.h.

Constructor & Destructor Documentation

~Migration()

virtual Migration::~Migration ( )

inlinevirtual

Definition at line 32 of file Migration.h.

Member Function Documentation

initialize()

bool Migration::initialize ( StateP  )

virtual

Perform initialization. Called before Operator::operate. By default, if the return value is false, the operator will not be used!

Returns

initialization success

Reimplemented from Operator.

Definition at line 21 of file Migration.cpp.

operate()

bool Migration::operate ( StateP  state )

virtual

Performs migration with current parameters:

• migration.freq: migration occurs each 'migration.freq' generations
• migration.number: migrate this number of individuals from each deme

Implements Operator.

Definition at line 60 of file Migration.cpp.

registerParameters()

void Migration::registerParameters ( StateP  )

virtual

Register parameters with the Registry. Called before Operator::initialize.

Reimplemented from Operator.

Definition at line 9 of file Migration.cpp.

Member Data Documentation

BEST

const int Migration::BEST = 0

staticprotected

Definition at line 17 of file Migration.h.

migFrequency_

uint Migration::migFrequency_

protected

Definition at line 14 of file Migration.h.

nEmigrants_

uint Migration::nEmigrants_

protected

Definition at line 15 of file Migration.h.

RANDOM

const int Migration::RANDOM = 1

staticprotected

Definition at line 18 of file Migration.h.

selOp_

std::vector<SelectionOperatorP> Migration::selOp_

protected

Definition at line 16 of file Migration.h.

state_

StateP Migration::state_

protected

Definition at line 13 of file Migration.h.

---

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

• D:/Projekt/ECF_trunk/ECF/Migration.h
• D:/Projekt/ECF_trunk/ECF/Migration.cpp