scheduler.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 SCHEDULER_H
#define SCHEDULER_H
#include <QList>
#include <QHash>
 
#include "activity.h"
class Expression;
 
namespace ABE {
class FMStand; // forward
class FMUnit; // forward
 
struct SchedulerOptions {
    SchedulerOptions(): useScheduler(false), useSustainableHarvest(1.), minScheduleHarvest(0), maxScheduleHarvest(0), maxHarvestLevel(0), harvestIntensity(1.), scheduleRebounceDuration(0), deviationDecayRate(0.), maxAbsoluteHarvest(-1.){  }
    bool useScheduler; 
    double useSustainableHarvest; 
    double minScheduleHarvest; 
    double maxScheduleHarvest; 
    double maxHarvestLevel; 
    double harvestIntensity; 
    double scheduleRebounceDuration; 
    double deviationDecayRate; 
    double maxAbsoluteHarvest; 
 
    void setup(QJSValue jsvalue);
    static QStringList mAllowedProperties;
};
 
class Scheduler
{
public:
    Scheduler(FMUnit* unit) { mUnit = unit; mExtraHarvest=0.; mFinalCutTarget=0.; mEnabled=false; }
    enum HarvestType { Thinning, EndHarvest, Salvage};
 
    void setEnabled(bool enabled) { mEnabled = enabled; }
    bool enabled() const { return mEnabled; }
 
 
    void addTicket(FMStand *stand, ActivityFlags *flags, double prob_schedule, double prob_execute);
 
    int clearItemsOfStand(const FMStand *stand);
 
    void run();
 
    void resetHarvestCounter() { mExtraHarvest = 0.; }
 
    bool forceHarvest(const FMStand *stand, const int max_years);
 
    void addExtraHarvest(const FMStand *stand, const double volume, HarvestType type);
 
    double plannedHarvests(double &rFinal, double &rThinning);
 
    void setHarvestTarget(double target_m3_ha, double thinning_target_m3_ha) { mFinalCutTarget = std::max(target_m3_ha,0.01);
                                                                               mThinningTarget = std::max(thinning_target_m3_ha,0.01); }
    double harvestTarget() const { return mFinalCutTarget; }
 
    double scoreOf(const int stand_id) const;
    QStringList info(const int stand_id) const;
    void dump() const;
 
private:
    void updateCurrentPlan();
    class SchedulerItem {
    public:
        SchedulerItem(): stand(nullptr), score(0.), scheduledYear(-1) {}
        bool operator<(const SchedulerItem &item);
        void calculate(); 
        FMStand *stand; 
        double harvest; 
        double harvestPerHa; 
        double scheduleScore; 
        double harvestScore; 
        double score; 
        HarvestType harvestType; 
        int  enterYear; 
        int  optimalYear; 
        int scheduledYear; 
        int forbiddenTo; 
        ActivityFlags *flags; 
    };
    struct ItemComparator
    {
        bool operator()( const SchedulerItem *lx, const SchedulerItem *rx ) const;
    };
    QList<SchedulerItem*> mItems; 
    QMultiHash<int, SchedulerItem*> mSchedule;
    SchedulerItem* item(const int stand_id) const;
    FMUnit *mUnit;
    double mExtraHarvest; 
    double mFinalCutTarget; 
    double mThinningTarget; 
    bool mEnabled; 
 
    static const int MAX_YEARS = 20;
    friend class UnitOut;
};
 
 
 
} // namespace
#endif // SCHEDULER_H