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

a iLand plugin for wind disturbances. More...

#include <windplugin.h>

Inheritance diagram for WindPlugin:
DisturbanceInterface SetupResourceUnitInterface

Public Member Functions

 WindPlugin ()
 
 ~WindPlugin ()
 
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 yearBegin ()
 function executes at the beginning of a year (e.g., cleanup) More...
 
void run ()
 main function that once a year (after growth) More...
 
WindModulewindModule ()
 
- Public Member Functions inherited from DisturbanceInterface
virtual ~DisturbanceInterface ()
 
- Public Member Functions inherited from SetupResourceUnitInterface
virtual ~SetupResourceUnitInterface ()
 

Detailed Description

a iLand plugin for wind disturbances.

Constructor & Destructor Documentation

◆ WindPlugin()

WindPlugin::WindPlugin ( )

◆ ~WindPlugin()

WindPlugin::~WindPlugin ( )

Member Function Documentation

◆ description()

QString WindPlugin::description ( )
virtual

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

Implements DisturbanceInterface.

◆ name()

QString WindPlugin::name ( )
virtual

a unique name of the plugin

Implements DisturbanceInterface.

◆ run()

void WindPlugin::run ( )
virtual

main function that once a year (after growth)

Implements DisturbanceInterface.

◆ setup()

void WindPlugin::setup ( )
virtual

setup after the main iLand model frame is created

Implements DisturbanceInterface.

◆ setupResourceUnit()

void WindPlugin::setupResourceUnit ( const ResourceUnit ru)
virtual

setup resource unit specific parameters

Implements SetupResourceUnitInterface.

◆ setupScripting()

void WindPlugin::setupScripting ( QJSEngine *  engine)
virtual

setup additional javascript related features

Implements DisturbanceInterface.

◆ version()

QString WindPlugin::version ( )
virtual

a version identification

Implements DisturbanceInterface.

◆ windModule()

WindModule * WindPlugin::windModule ( )
inline

◆ yearBegin()

void WindPlugin::yearBegin ( )
virtual

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

Implements DisturbanceInterface.


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