fireplugin.h

Go to the documentation of this file.

/********************************************************************************************
**    iLand - an individual based forest landscape and disturbance model
**    http://iland-model.org
**    Copyright (C) 2009-  Werner Rammer, Rupert Seidl
**
**    This program is free software: you can redistribute it and/or modify
**    it under the terms of the GNU General Public License as published by
**    the Free Software Foundation, either version 3 of the License, or
**    (at your option) any later version.
**
**    This program is distributed in the hope that it will be useful,
**    but WITHOUT ANY WARRANTY; without even the implied warranty of
**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**    GNU General Public License for more details.
**
**    You should have received a copy of the GNU General Public License
**    along with this program.  If not, see <http://www.gnu.org/licenses/>.
********************************************************************************************/
 
#ifndef FIREPLUGIN_H
#define FIREPLUGIN_H
 
#include <QObject>
#include "firemodule.h"
 
#include "plugin_interface.h"
class FirePlugin: public QObject,
        public DisturbanceInterface,
        public WaterInterface,
        public SetupResourceUnitInterface
{
    Q_OBJECT
    #if QT_VERSION >= 0x050000
    Q_PLUGIN_METADATA(IID "at.ac.boku.iland.fireplugin" FILE  "fireplugin.json")
    #endif
    Q_INTERFACES(DisturbanceInterface WaterInterface SetupResourceUnitInterface)
 
 
public:
    FirePlugin();
    // general interface details
    QString name(); 
    QString version(); 
    QString description(); 
 
    // setup
    void setup();
    void setupResourceUnit(const ResourceUnit *ru) { mFire.setup(ru);}
    void setupScripting(QJSEngine *engine);
 
 
    // calculations
    void yearBegin() { mFire.yearBegin(); }
    void run() { mFire.run(); }
    // access to water data
    void calculateWater(const ResourceUnit *resource_unit, const WaterCycleData *water_data) {mFire.calculateDroughtIndex(resource_unit, water_data); }
 
    // special functions for direct access (testing)
    FireModule *fireModule() { return &mFire; }
private:
    FireModule mFire;
};
 
#endif // FIREPLUGIN_H