modelcontroller.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 MODELCONTROLLER_H
#define MODELCONTROLLER_H
#include <QObject>
#include <QHash>
#include "grid.h"
#include "layeredgrid.h"
class Model;
class MainWindow;
class MapGrid;
class Species;
 
class ModelController: public QObject
{
    Q_OBJECT
public:
    ModelController();
    ~ModelController();
    void setMainWindow(MainWindow *mw) { mViewerWindow = mw; }
    MainWindow *mainWindow() { return mViewerWindow; }
    void connectSignals(); // connect signal/slots to the main window if available
    Model *model() const { return mModel; }
    // bool checkers...
    bool canCreate(); 
    bool canDestroy(); 
    bool canRun(); 
    bool isRunning(); 
    bool isStartingUp() { return mIsStartingUp; } 
    bool isFinished(); 
    bool isPaused(); 
    bool isBusy() { return mIsBusy; } 
    bool hasError() { return mHasError; } 
    QString lastError() { return mLastError; } 
    // simulation length
    int currentYear() const; 
    int totalYears() const { return mYearsToRun; } 
    QString timeString() const; 
    // error handling
    void throwError(const QString msg);
    // dynamic outputs (variable fields)
    void setDynamicOutputEnabled(bool enabled) { mDynamicOutputEnabled = enabled; }
    void setupDynamicOutput(QString fieldList);
    QString dynamicOutput();
    // some informational services
    QList<const Species *> availableSpecies();
    void setLoadedJavascriptFile(QString filename) { mLastLoadedJSFile = filename; }
    QString loadedJavascriptFile() const { return mLastLoadedJSFile; }
 
 
    void saveScreenshot(QString file_name); 
    void addGrid(const FloatGrid *grid, const QString &name, const GridViewType view_type, double min_value, double max_value);
    void paintMap(MapGrid *map, double min_value, double max_value);
 
    void addLayers(const LayeredGridBase *layers, const QString &name);
    void removeLayers(const LayeredGridBase *layers);
    void addPaintLayers(QObject *handler, const QStringList names, const QVector<GridViewType> view_types=QVector<GridViewType>());
    void removePaintLayers(QObject *handler);
    Grid<double> *preparePaintGrid(QObject *handler, QString name, std::pair<QStringList, QStringList> *rNamesColors);
    QStringList evaluateClick(QObject *handler, const QPointF coord, const QString &grid_name);
    double valueAtHandledGrid(QObject *handler, const QPointF coord, const int layer_id);
    void setViewport(QPointF center_point, double scale_px_per_m);
 
    void setUIShortcuts(QVariantMap shortcuts);
signals:
    void finished(QString errorMessage); 
    void year(int year); 
    void bufferLogs(bool do_buffer); 
    void stateChanged(); 
public slots:
    void setFileName(QString initFileName); 
    void create(); 
    void destroy(); 
    void run(int years); 
    bool runYear(); 
    bool pause(); 
    bool continueRun(); 
    void cancel(); 
    void repaint(); 
    void saveDebugOutputJs(bool do_clear); 
private slots:
    void runloop();
private:
    bool internalRun(); 
    void internalStop(); 
    void fetchDynamicOutput(); 
    void saveDebugOutputs(bool is_final); 
    void saveDebugOutputsCore(QString p, bool do_append); 
    MainWindow *mViewerWindow;
    Model *mModel;
    bool mPaused;
    bool mRunning;
    bool mFinished;
    bool mCanceled;
    bool mHasError;
    bool mIsStartingUp;
    bool mIsBusy;
    QString mLastError;
    int mYearsToRun;
    QString mInitFile;
    bool mDynamicOutputEnabled;
    QStringList mDynFieldList;
    QStringList mDynData;
    QString mLastLoadedJSFile;
    QTime mStartTime;
 
};
 
#endif // MODELCONTROLLER_H