forestmanagementengine.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 FORESTMANAGEMENTENGINE_H
#define FORESTMANAGEMENTENGINE_H
#include <QMultiMap>
#include <QVector>
 
#include "abegrid.h"
 
class QJSEngine; // forward
class MapGrid; // forward
class ResourceUnit; // forward
class Tree; // forward
 
 
namespace ABE {
 
class FMUnit; // forward
class FMStand; // forward
class FMSTP; // forward
class Agent; // forward
class AgentType; // forward
class FomeScript; // forward
 
class ForestManagementEngine
{
public:
    // life cycle
    ForestManagementEngine();
    ~ForestManagementEngine();
    // engine instance (singleton)
    static ForestManagementEngine *instance() { if (singleton_fome_engine) return singleton_fome_engine; singleton_fome_engine = new ForestManagementEngine; return singleton_fome_engine; }
    static const MapGrid *standGrid();
 
    // setup
    void setup(); 
    void initialize(); 
    void clear(); 
    void abortExecution(const QString &message);
    bool isCancel() const { return mCancel; }
    void runOnInit(bool before_init); 
 
    // main function
    void run(int debug_year=-1);
    void yearEnd();
 
    // properties
    int currentYear() { return mCurrentYear; }
    bool enabled() const { return mEnabled; }
    void setEnabled(bool enable) {mEnabled=enable; }
    static QJSEngine *scriptEngine();
    FomeScript *scriptBridge() const {return mScriptBridge; }
 
    // setting up agents and stps
    void addSTP(FMSTP* stp) { mSTP.push_back(stp);}
    void addAgentType(AgentType* at) { mAgentTypes.append(at);}
    void addAgent(Agent *agent) { mAgents.append(agent);}
    AgentType *agentType(const QString &name);
    Agent *agent(const QString &name);
 
 
    FMSTP *stp(QString stp_name) const;
    FMStand *stand(int stand_id) const;
    //QVector<FMStand*> stands() const {return mStands; }
    const QMultiMap<FMUnit*, FMStand*> &stands() const {return mUnitStandMap; }
    const QVector<FMUnit*> &units() const { return mUnits; }
    QVariantList standIds() const;
 
    FMStand *standAt(QPointF coord) const { return mFMStandGrid.constValueAt(coord); }
    // functions
 
    void notifyTreeRemoval(Tree* tree, int reason);
    bool notifyBarkbeetleAttack(const ResourceUnit *ru, const double generations, int n_infested_px);
 
    FMStand *splitExistingStand(FMStand *stand);
 
    void test();
    QStringList evaluateClick(const QPointF coord, const QString &grid_name);
 
 
private:
    static int mMaxStandId;
    void setupScripting();
    void prepareRun();
    void finalizeRun();
    void setupOutputs();
    void runJavascript(bool after_processing);
 
    static ForestManagementEngine *singleton_fome_engine;
    int mCurrentYear; 
 
    QVector<FMSTP*> mSTP;
 
    // scripting bridge (accessing model properties from javascript)
    FomeScript *mScriptBridge;
 
    // forest management units
    QVector<FMUnit*> mUnits; 
    // mapping of stands to units
    QMultiMap<FMUnit*, FMStand*> mUnitStandMap;
    QVector<FMStand*> mStands;
    QHash<int, FMStand*> mStandHash;
 
    // agents
    QVector<AgentType*> mAgentTypes; 
    QVector<Agent*> mAgents; 
 
    // grids, visuals, etc.
    Grid<FMStand*> mFMStandGrid;
    ABELayers mStandLayers;
 
    bool mCancel;
    bool mEnabled; 
    bool mStandLayoutChanged;
    QString mLastErrorMessage;
 
    //
    friend class UnitOut;
};
 
 
} // namespace
#endif // FORESTMANAGEMENTENGINE_H