biteitem.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 BITEITEM_H
#define BITEITEM_H
 
#include "bite_global.h"
#include "bitecell.h"
#include <QObject>
 
namespace ABE {
class FMTreeList; // forward
class FMSaplingList; // forward
}
 
namespace BITE {
 
class BiteAgent;
class BiteCell;
 
class BiteItem : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(BiteAgent* agent READ agent)
public:
    explicit BiteItem(QObject *parent = nullptr);
    Q_INVOKABLE BiteItem(QJSValue obj);
    BiteAgent *agent() const { return mAgent; }
 
 
    virtual void setup(BiteAgent *agent);
    virtual QString info();
 
    bool runCells() const { return mRunCells; }
 
    QString name() const {return mName; }
    void setName(QString name) { mName = name; }
 
    QString description() const {return mDescription; }
 
 
    virtual void notify(BiteCell *cell, BiteCell::ENotification what);
signals:
 
public slots:
    // actions
    virtual void afterSetup(); 
    virtual void beforeRun(); 
    virtual void run();
    virtual void runCell(BiteCell *cell, ABE::FMTreeList *treelist, ABE::FMSaplingList *saplist);
 
protected:
 
    int cellSize() const;
    virtual QStringList allowedProperties();
    void checkProperties(QJSValue obj);
    QJSValue thisJSObj() { return mThis; }
    QJSValue mObj; 
    QJSValue mThis; 
    void setRunCells(bool rc) { mRunCells = rc; }
    bool verbose();
private:
    BiteAgent *mAgent;
    QString mName;
    QString mDescription;
    bool mRunCells;
 
};
 
} // end namespace
#endif // BITEITEM_H