management.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 MANAGEMENT_H
#define MANAGEMENT_H
 
#include <QObject>
#include <QList>
#include <QtCore/QVariantList>
#include "scriptglobal.h"
#include "scripttree.h"
 
class Tree;
class QJSEngine;
class Management : public QObject //, protected QScriptable
{
    Q_OBJECT
    Q_PROPERTY(int count READ count)
    Q_PROPERTY(double removeFoliage READ removeFoliage WRITE setRemoveFoliage)
    Q_PROPERTY(double removeBranch READ removeBranch WRITE setRemoveBranch)
    Q_PROPERTY(double removeStem READ removeStem WRITE setRemoveStem)
public:
    Management();
    ~Management();
    void run();
    void loadScript(const QString &fileName);
    QString scriptFile() const { return mScriptFile; }
 
    // property getter & setter for removal fractions
    double removeFoliage() const { return mRemoveFoliage; }
    double removeBranch() const { return mRemoveBranch; }
    double removeStem() const { return mRemoveStem; }
 
    void setRemoveFoliage(const double fraction)  { mRemoveFoliage = fraction; }
    void setRemoveBranch(const double fraction)  { mRemoveBranch = fraction; }
    void setRemoveStem(const double fraction)  { mRemoveStem = fraction; }
 
    int count() const {return mTrees.count();} 
 
public slots:
    QJSValue tree(int index);
    QJSValue treeObject(int index);
 
    double mean(QString expression, QString filter=QString()) { return aggregate_function( expression, filter, "mean"); }
    double sum(QString expression, QString filter=QString()) { return aggregate_function( expression, filter, "sum"); }
    int remain(int number);
    int killPct(int pctfrom, int pctto, int number);
    int killAll(); 
    int disturbanceKill(double stem_to_soil_fraction, double stem_to_snag_fraction, double branch_to_soil_fraction, double branch_to_snag_fraction, QString agent);
    int kill(QString filter, double fraction);
    // management
    int managePct(int pctfrom, int pctto, int number);
    int manageAll(); 
    int manage(QString filter, double fraction);
    void cutAndDrop();
 
    double percentile(int pct); 
    int loadAll() { return load(QString()); } 
    int load(QString filter); 
    int loadResourceUnit(int ruindex); 
    void loadFromTreeList(QList<Tree*>tree_list); 
    void loadFromMap(const MapGrid *map_grid, int key); 
    int loadFromMap(MapGridWrapper *wrap, int key); 
    void killSaplings(MapGridWrapper *wrap, int key, QString filter=QString());
    void killSaplingsResourceUnit(int ruindex);
    void removeSoilCarbon(MapGridWrapper *wrap, int key, double SWDfrac, double DWDfrac, double litterFrac, double soilFrac);
    void slashSnags(MapGridWrapper *wrap, int key, double slash_fraction);
    void sort(QString statement); 
    int filter(QString filter); 
    int filterIdList(QVariantList idList); 
    void randomize(); 
private:
    QString executeScript(QString cmd="");
    int remove_percentiles(int pctfrom, int pctto, int number, bool management);
    int remove_trees(QString expression, double fraction, bool management);
    double aggregate_function(QString expression, QString filter, QString type);
    void throwError(const QString &errormessage);
 
    // removal fractions
    double mRemoveFoliage, mRemoveBranch, mRemoveStem;
    QString mScriptFile;
    QList<QPair<Tree*, double> > mTrees;
    QJSEngine *mEngine;
    int mRemoved;
    QJSValue mTreeValue;
    ScriptTree *mTree;
};
 
#endif // MANAGEMENT_H