iLand
Public Member Functions | List of all members
BarkBeetlePlugin Class Reference

#include <barkbeetleplugin.h>

Inheritance diagram for BarkBeetlePlugin:
DisturbanceInterface SetupResourceUnitInterface TreeDeathInterface

Public Member Functions

 BarkBeetlePlugin ()
 
QString name ()
 a unique name of the plugin More...
 
QString version ()
 a version identification More...
 
QString description ()
 some additional description. This info is shown in the GUI and is printed to the log file. More...
 
void setup ()
 setup after the main iLand model frame is created More...
 
void setupResourceUnit (const ResourceUnit *ru)
 setup resource unit specific parameters More...
 
void setupScripting (QJSEngine *engine)
 setup additional javascript related features More...
 
void treeDeath (const Tree *tree, const int removal_type)
 function is called whenever a tree dies in iLand (in order to track storm damage) More...
 
void yearBegin ()
 function executes at the beginning of a year (e.g., cleanup) More...
 
void run ()
 main function that once a year (after growth) More...
 
BarkBeetleModulebarkBeetleModule ()
 
- Public Member Functions inherited from DisturbanceInterface
virtual ~DisturbanceInterface ()
 
- Public Member Functions inherited from SetupResourceUnitInterface
virtual ~SetupResourceUnitInterface ()
 
- Public Member Functions inherited from TreeDeathInterface
virtual ~TreeDeathInterface ()
 

Constructor & Destructor Documentation

◆ BarkBeetlePlugin()

BarkBeetlePlugin::BarkBeetlePlugin ( )

Member Function Documentation

◆ barkBeetleModule()

BarkBeetleModule * BarkBeetlePlugin::barkBeetleModule ( )
inline

◆ description()

QString BarkBeetlePlugin::description ( )
virtual

some additional description. This info is shown in the GUI and is printed to the log file.

Implements DisturbanceInterface.

◆ name()

QString BarkBeetlePlugin::name ( )
virtual

a unique name of the plugin

Implements DisturbanceInterface.

◆ run()

void BarkBeetlePlugin::run ( )
inlinevirtual

main function that once a year (after growth)

Implements DisturbanceInterface.

◆ setup()

void BarkBeetlePlugin::setup ( )
virtual

setup after the main iLand model frame is created

Implements DisturbanceInterface.

◆ setupResourceUnit()

void BarkBeetlePlugin::setupResourceUnit ( const ResourceUnit ru)
inlinevirtual

setup resource unit specific parameters

Implements SetupResourceUnitInterface.

◆ setupScripting()

void BarkBeetlePlugin::setupScripting ( QJSEngine *  engine)
virtual

setup additional javascript related features

Implements DisturbanceInterface.

◆ treeDeath()

void BarkBeetlePlugin::treeDeath ( const Tree tree,
const int  removal_type 
)
inlinevirtual

function is called whenever a tree dies in iLand (in order to track storm damage)

Implements TreeDeathInterface.

◆ version()

QString BarkBeetlePlugin::version ( )
virtual

a version identification

Implements DisturbanceInterface.

◆ yearBegin()

void BarkBeetlePlugin::yearBegin ( )
inlinevirtual

function executes at the beginning of a year (e.g., cleanup)

Implements DisturbanceInterface.


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