plugin_interface.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 PLUGIN_INTERFACE_H
#define PLUGIN_INTERFACE_H
 
#include <QtPlugin>
 
class QJSEngine; // forward
class ResourceUnit; // forward
 
class DisturbanceInterface
{
public:
    virtual ~DisturbanceInterface() {}
 
    // general information / properties
    virtual QString name()=0; 
    virtual QString version()=0; 
    virtual QString description()=0; 
 
    // setup
    virtual void setup()=0; 
    virtual void yearBegin()=0; 
    virtual void run()=0; 
    virtual void setupScripting(QJSEngine *engine)=0; 
};
 
class SetupResourceUnitInterface
{
public:
    virtual ~SetupResourceUnitInterface() {}
    virtual void setupResourceUnit(const ResourceUnit *ru)=0;
 
};
 
class WaterCycleData; // forward
class ResourceUnit; // forward
class WaterInterface
{
public:
    virtual ~WaterInterface() {}
 
    virtual void calculateWater(const ResourceUnit *resource_unit, const WaterCycleData *water_data)=0;
};
 
class Tree; // forward
//class Tree::TreeRemovalType;
class TreeDeathInterface
{
public:
    virtual ~TreeDeathInterface() {}
    virtual void treeDeath(const Tree *tree, const int removal_type)=0;
};
 
Q_DECLARE_INTERFACE(DisturbanceInterface, "at.ac.boku.iland.DisturbanceInterface/1.0")
 
Q_DECLARE_INTERFACE(WaterInterface, "at.ac.boku.iland.WaterInterface/1.0")
 
Q_DECLARE_INTERFACE(SetupResourceUnitInterface, "at.ac.boku.iland.SetupResourceUnitInterface/1.0")
 
Q_DECLARE_INTERFACE(TreeDeathInterface, "at.ac.boku.iland.TreeDeathInterface/1.0")
 
#endif // PLUGIN_INTERFACE_H