FirePlugin Class Reference

#include <fireplugin.h>

Inheritance diagram for FirePlugin:

Public Member Functions
	FirePlugin ()
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...
void	calculateWater (const ResourceUnit *resource_unit, const WaterCycleData *water_data)
FireModule *	fireModule ()
Public Member Functions inherited from DisturbanceInterface
virtual	~DisturbanceInterface ()
Public Member Functions inherited from WaterInterface
virtual	~WaterInterface ()
Public Member Functions inherited from SetupResourceUnitInterface
virtual	~SetupResourceUnitInterface ()

Constructor & Destructor Documentation

FirePlugin()

FirePlugin::FirePlugin

(

)

Member Function Documentation

calculateWater()

void FirePlugin::calculateWater ( const ResourceUnit *  resource_unit, const WaterCycleData *  water_data  )

inlinevirtual

Implements WaterInterface.

description()

QString FirePlugin::description ( )

virtual

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

Implements DisturbanceInterface.

fireModule()

FireModule * FirePlugin::fireModule ( )

inline

name()

QString FirePlugin::name ( )

virtual

a unique name of the plugin

Implements DisturbanceInterface.

run()

void FirePlugin::run ( )

inlinevirtual

main function that once a year (after growth)

Implements DisturbanceInterface.

setup()

void FirePlugin::setup ( )

virtual

setup after the main iLand model frame is created

Implements DisturbanceInterface.

setupResourceUnit()

void FirePlugin::setupResourceUnit ( const ResourceUnit *  ru )

inlinevirtual

setup resource unit specific parameters

Implements SetupResourceUnitInterface.

setupScripting()

void FirePlugin::setupScripting ( QJSEngine *  engine )

virtual

setup additional javascript related features

Implements DisturbanceInterface.

version()

QString FirePlugin::version ( )

virtual

a version identification

Implements DisturbanceInterface.

yearBegin()

void FirePlugin::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:

• C:/dev/iland/src/plugins/fire/fireplugin.h
• C:/dev/iland/src/plugins/fire/fireplugin.cpp