bitecell.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 BCELL_H
#define BCELL_H
 
class ResourceUnit;
class Tree;
#include <QPointF>
 
#include "biteclimate.h"
 
namespace ABE {
class FMTreeList; // forward
class FMSaplingList; // forward
}
 
namespace BITE {
 
class BiteAgent;
 
class BiteCell
{
public:
    BiteCell() : mRU(nullptr), mIsActive(false), mIsSpreading(false), mIndex(-1), mYearsLiving(0), mCumYearsLiving(0), mTreesLoaded(false), mSaplingsLoaded(false), mArea(0.f) {}
    void setup(int cellidx, QPointF pos, BiteAgent *agent);
    int index() const {return mIndex;}
    BiteAgent *agent() const { return mAgent; }
    QString info();
 
    bool isValid() const { return mRU!=nullptr; }
 
    bool isActive() const {return mIsActive; }
    void setActive(bool activate) { mIsActive = activate; }
 
    bool isSpreading() const {return mIsSpreading; }
    void setSpreading(bool activate) { mIsSpreading = activate; }
 
    void setTreesLoaded(bool loaded) { mTreesLoaded = loaded; }
    void setSaplingsLoaded(bool loaded) { mSaplingsLoaded = loaded; }
    void checkTreesLoaded(ABE::FMTreeList *treelist);
    void checkSaplingsLoaded(ABE::FMSaplingList *saplist);
    bool areTreesLoaded() const { return mTreesLoaded; }
    bool areSaplingsLoaded() const { return mSaplingsLoaded; }
 
    int yearsLiving() const { return mYearsLiving; }
    int yearLastSpread() const { return mLastSpread; }
    int cumYearsLiving() const { return mCumYearsLiving; }
 
    // climate vars
    double climateVar(int var_index) const;
    // actions
    void die();
    void finalize();
    enum ENotification { CellDied, CellColonized, CellSpread, CellImpacted };
    void notify(ENotification what);
 
    int loadTrees(ABE::FMTreeList *treelist);
    int loadSaplings(ABE::FMSaplingList *saplinglist);
private:
    void largeCellSetup(QPointF pos);
    ResourceUnit *mRU; 
    BiteAgent *mAgent; 
    bool mIsActive; 
    bool mIsSpreading; 
    int mIndex; 
    int mYearsLiving; 
    int mLastSpread; 
    int mCumYearsLiving; 
 
    bool mTreesLoaded; 
    bool mSaplingsLoaded; 
 
    float mArea; 
};
 
} // end namespace
#endif // BCELL_H