Subversion Repositories public iLand

/********************************************************************************************
**    iLand - an individual based forest landscape and disturbance model
**    http://iland.boku.ac.at
**    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 FIRESCRIPT_H
#define FIRESCRIPT_H

#include <QObject>
class FireModule; // forward
class FireScript : public QObject
{
    Q_OBJECT
    Q_PROPERTY(int id READ id)
    Q_PROPERTY(int x READ x)
    Q_PROPERTY(int y READ y)

public:
    explicit FireScript(QObject *parent = 0);
    void setFireModule(FireModule *module) { mFire = module; }
    int id() const; ///< the id of the last ignited fire during the simulation
    double x() const; ///< the x-coordinate of the last ignition
    double y() const; ///< the x-coordinate of the last ignition
    static QString fireRUValueType; // for the exporter
signals:

public slots:
/**    Ignite a fire event with pre-defined properties, i.e. at a given location (parameters x_meter, y_meter) with given conditions (i.e. wind direction and speed). The fire size (as taken from the distribution)
    x_meter, y_meter: metric coordinates of the ignition point in the landscape
    firesize: provide a fire size (m2). The fire size will be drawn from the fire size distribution if firesize=-1 or omitted.
    windspeed: wind speed (m/s), drawn randomly if omitted or -1.
    winddirection: wind direction (0°=N..180°=S..270=W°), drawn randomly if omitted or set to -1.
    Returns the burnt area */
    double ignite(double x, double y, double firesize=-1, double windspeed=-1, double winddirection=-1);
    bool gridToFile(QString grid_type, QString file_name); ///< create a "ESRI-grid" text file 'grid_type' is one of a fixed list of names, 'file_name' the ouptut file location

private:
    FireModule *mFire;

};

#endif // FIRESCRIPT_H