iLand
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
BarkBeetleModule Class Reference

The BarkBeetleModule class is the main class of the bark beetle module. More...

#include <barkbeetlemodule.h>

Public Member Functions

 BarkBeetleModule ()
 
 ~BarkBeetleModule ()
 
void setup ()
 general setup More...
 
void setup (const ResourceUnit *ru)
 setup for a specific resource unit More...
 
void loadParameters (bool do_reset=true)
 load params from XML More...
 
void clearGrids ()
 reset the state of the internal grids (used for javascript based tests) More...
 
void loadAllVegetation ()
 scan the state of the vegetation of the full landscape More...
 
void run (int iteration=0)
 main function to execute the bark beetle module (iteration can be non-0 when called from Javascript) More...
 
void treeDeath (const Tree *tree)
 function that is called whenever a tree dies somewhere in iLand More...
 
void yearBegin ()
 called automatically More...
 
int manualYearBegin ()
 call from script (from script) More...
 
int internalYear () const
 
void setSimulate (bool do_simulate)
 
bool simulate () const
 
void setEnabled (bool do_set_enabled)
 
bool enabled () const
 

Static Public Member Functions

static double cellsize ()
 

Friends

class BarkBeetleScript
 
class BarkBeetleOut
 

Detailed Description

The BarkBeetleModule class is the main class of the bark beetle module.

BarkBeetleModule is the main class for the bark beetle module.

The module simulates the spruce bark beetle (Ips typographus) spatially explicit on the landscape. The number of possible bark beetle generations is calculated based on climate data (BBGenerations)

It calculates the development of generations, the spread and attack of beetles. It operates on a 10m grid.

Constructor & Destructor Documentation

◆ BarkBeetleModule()

BarkBeetleModule::BarkBeetleModule ( )

◆ ~BarkBeetleModule()

BarkBeetleModule::~BarkBeetleModule ( )

Member Function Documentation

◆ cellsize()

static double BarkBeetleModule::cellsize ( )
inlinestatic

◆ clearGrids()

void BarkBeetleModule::clearGrids ( )

reset the state of the internal grids (used for javascript based tests)

◆ enabled()

bool BarkBeetleModule::enabled ( ) const
inline

◆ internalYear()

int BarkBeetleModule::internalYear ( ) const
inline

◆ loadAllVegetation()

void BarkBeetleModule::loadAllVegetation ( )

scan the state of the vegetation of the full landscape

◆ loadParameters()

void BarkBeetleModule::loadParameters ( bool  do_reset = true)

load params from XML

◆ manualYearBegin()

int BarkBeetleModule::manualYearBegin ( )
inline

call from script (from script)

◆ run()

void BarkBeetleModule::run ( int  iteration = 0)

main function to execute the bark beetle module (iteration can be non-0 when called from Javascript)

◆ setEnabled()

void BarkBeetleModule::setEnabled ( bool  do_set_enabled)
inline

◆ setSimulate()

void BarkBeetleModule::setSimulate ( bool  do_simulate)
inline

◆ setup() [1/2]

void BarkBeetleModule::setup ( )

general setup

◆ setup() [2/2]

void BarkBeetleModule::setup ( const ResourceUnit ru)

setup for a specific resource unit

◆ simulate()

bool BarkBeetleModule::simulate ( ) const
inline

◆ treeDeath()

void BarkBeetleModule::treeDeath ( const Tree tree)

function that is called whenever a tree dies somewhere in iLand

◆ yearBegin()

void BarkBeetleModule::yearBegin ( )

called automatically

Friends And Related Function Documentation

◆ BarkBeetleOut

friend class BarkBeetleOut
friend

◆ BarkBeetleScript

friend class BarkBeetleScript
friend

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