DisturbanceInterface Class Reference

#include <plugin_interface.h>

Inheritance diagram for DisturbanceInterface:

Public Member Functions
virtual	~DisturbanceInterface ()
virtual QString	name ()=0
	a unique name of the plugin More...
virtual QString	version ()=0
	a version identification More...
virtual QString	description ()=0
	some additional description. This info is shown in the GUI and is printed to the log file. More...
virtual void	setup ()=0
	setup after general iLand model frame is created. More...
virtual void	yearBegin ()=0
	function executes at the beginning of a year (e.g., cleanup) More...
virtual void	run ()=0
	main function that once a year (after growth) More...
virtual void	setupScripting (QJSEngine *engine)=0
	allow module specific javascript functions/classes More...

Constructor & Destructor Documentation

~DisturbanceInterface()

virtual DisturbanceInterface::~DisturbanceInterface ( )

inlinevirtual

Member Function Documentation

description()

virtual QString DisturbanceInterface::description ( )

pure virtual

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

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

name()

virtual QString DisturbanceInterface::name ( )

pure virtual

a unique name of the plugin

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

run()

virtual void DisturbanceInterface::run ( )

pure virtual

main function that once a year (after growth)

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

setup()

virtual void DisturbanceInterface::setup ( )

pure virtual

setup after general iLand model frame is created.

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

setupScripting()

virtual void DisturbanceInterface::setupScripting ( QJSEngine *  engine )

pure virtual

allow module specific javascript functions/classes

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

version()

virtual QString DisturbanceInterface::version ( )

pure virtual

a version identification

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

yearBegin()

virtual void DisturbanceInterface::yearBegin ( )

pure virtual

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

Implemented in BarkBeetlePlugin, FirePlugin, and WindPlugin.

---

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

• C:/dev/iland/src/core/plugin_interface.h