fmunit.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 FMUNIT_H
#define FMUNIT_H
#include <QString>
 
namespace ABE {
 
 
class Agent; // forward
class Scheduler;
class FMUnit
{
public:
    FMUnit(const Agent *agent);
    ~FMUnit();
    void setId(const QString &id);
    const QString &id() const {return mId; }
    Scheduler *scheduler() {return mScheduler; }
    const Scheduler *constScheduler() const { return mScheduler; }
    const Agent* agent() const { return mAgent; }
    double area() const { return mTotalArea; } 
    int numberOfStands() const { return mNumberOfStands; } 
    void setNumberOfStands(int new_number) { mNumberOfStands = new_number; } 
    double volume() const { return mTotalVolume/area(); } 
    double annualIncrement() const { return mMAI; } 
    void resetHarvestCounter();
    // agent properties
    double U() const { return mU; }
    int thinningIntensity() const { return mThinningIntensityClass; }
    int targetSpeciesIndex() const { return mSpeciesCompositionIndex; }
    const QString &harvestMode() const { return mHarvestMode; }
 
    void setU(const double rotation_length) { mU = rotation_length; }
    void setThinningIntensity(const int th_class) { mThinningIntensityClass = th_class; }
    void setTargetSpeciesCompositionIndex(const int index) { mSpeciesCompositionIndex = index; }
    void setHarvestMode(const QString new_mode) { mHarvestMode = new_mode; }
 
    void setAverageMAI(const double avg_mai) { mAverageMAI = avg_mai; }
    double averageMAI() const { return mAverageMAI; }
    // actions
 
    void managementPlanUpdate();
 
    void setForceUpdateManagementPlan() { mForceUpdateManagementPlan = true; }
    bool forceUpdateManagementPlan() const { return mForceUpdateManagementPlan; }
 
    void runAgent();
 
    void updatePlanOfCurrentYear();
 
    void addRealizedHarvest(const double harvest_m3) { mRealizedHarvest+=harvest_m3; }
 
    void aggregate();
    QStringList info() const;
 
private:
    double annualTotalHarvest() const {return mRealizedHarvest-mRealizedHarvestLastYear; } 
    double annualThinningHarvest() const; 
    QString mId;
    const Agent *mAgent;
    Scheduler *mScheduler;
    int mNumberOfStands; 
    double mAnnualHarvestTarget; 
    double mAnnualThinningTarget; 
    double mRealizedHarvest; 
    double mRealizedHarvestLastYear; 
    double mAnnualHarvest; 
    double mMAI; 
    double mHDZ; 
    double mMeanAge; 
    double mTotalArea; 
    double mTotalVolume; 
    double mTotalPlanDeviation; 
 
    double mU; 
    int mSpeciesCompositionIndex; 
    int mThinningIntensityClass; 
    QString mHarvestMode; 
 
    double mAverageMAI; 
    bool mForceUpdateManagementPlan; 
 
 
    friend class UnitOut;
};
 
} // namespace
#endif // FOMEUNITS_H