fmstp.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 FOMESTP_H
#define FOMESTP_H
 
#include "fmstand.h"
#include "activity.h"
#include "actsalvage.h"
 
#include <QJSValue>
#include <QList>
 
class Expression; // forward
 
namespace ABE {
 
class Activity; // forward
 
class FMSTP
{
public:
    FMSTP();
    ~FMSTP();
    const QString &name() const {return mName; }
    Activity *activity(const QString &name) const;
    int activityIndex(Activity* act) { return mActivities.indexOf(act); }
 
    void setup(QJSValue &js_value, const QString name=QString());
    QVector<ActivityFlags> defaultFlags() {return mActivityStand; }
    Events &events() { return mEvents; }
    QJSValue *JSoptions() { return &mOptions; }
 
    int rotationLengthOfType(const int type) { if (type>0 && type<4) return mRotationLength[type-1]; return 0;}
    int rotationLengthType(const int length) const { for (int i=0;i<3;++i) if (mRotationLength[i]==length) return i+1; return -1; } // TODO: fix
    ActSalvage *salvageActivity() const { return mSalvage; }
 
    bool executeRepeatingActivities(FMStand *stand);
 
    void evaluateDynamicExpressions(FMStand *stand);
    // helper functions
    void dumpInfo();
    static void setVerbose(bool verbose) {mVerbose = verbose; }
    static bool verbose()  {return mVerbose; } 
    static QJSValue valueFromJs(const QJSValue &js_value, const QString &key, const QString default_value=QString(), const QString &errorMessage=QString());
    static bool boolValueFromJs(const QJSValue &js_value, const QString &key, const bool default_bool_value, const QString &errorMessage=QString());
 
    static bool checkObjectProperties(const QJSValue &js_value, const QStringList &allowed_properties, const QString &errorMessage=QString());
    static QJSValue evaluateJS(QJSValue value);
 
private:
    void internalSetup(const QJSValue &js_value, int level=0);
    QString mName; 
    void setupActivity(const QJSValue &js_value, const QString &name);
    void clear(); 
    Events mEvents;
    static bool mVerbose; 
    bool mHasRepeatingActivities; 
    QVector<Activity*> mActivities; 
    QVector<ActivityFlags> mActivityStand; 
    QStringList mActivityNames;  
    // special activities
    ActSalvage *mSalvage;
 
    // STP-level properties
    int mRotationLength[3]; 
 
    QJSValue mOptions; 
 
};
 
} // namespace
 
#endif // FOMESTP_H