scenario.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
// DISPLACE: DYNAMIC INDIVIDUAL VESSEL-BASED SPATIAL PLANNING
// AND EFFORT DISPLACEMENT
// Copyright (c) 2012-2019 Francois Bastardie <fba@aqua.dtu.dk>

//    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 2 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, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
// --------------------------------------------------------------------------

/* --------------------------------------------------------------------------
 * DISPLACE: DYNAMIC INDIVIDUAL VESSEL-BASED SPATIAL PLANNING
 * AND EFFORT DISPLACEMENT
 * Copyright (c) 2012, 2013, 2014 Francois Bastardie <fba@aqua.dtu.dk>
 *
 *    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 2 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, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 * --------------------------------------------------------------------------
 */
#ifndef SCENARIO_H
#define SCENARIO_H

#include <idtypes.h>
#include <QString>
#include <QList>
#include <QStringList>

#include <vector>

class Scenario
{
private:
    QStringList dyn_alloc_sce;
    QStringList dyn_pop_sce;
    QString biolsce;
    QString fleetsce;
    int freq_do_growth;
    int freq_redispatch_the_pop;
    int graph;
    int nrow_coord;
    int nrow_graph;
    types::NodeId a_port;
    QStringList graph_res;
    bool is_individual_vessel_quotas;
    bool check_all_stocks_before_going_fishing;
    bool use_dtrees;

    QString mDtGoFishing;
    QString mDtChooseGround;
    QString mDtStartFishing;
    QString mDtChangeGround;
    QString mDtStopFishing;
    QString mDtChangePort;

    QStringList tariff_pop;
    int freq_update_tariff_code;
    int update_tariffs_based_on_lpue_or_dpue_code;
    QStringList arbitary_breaks_for_tariff;
    int total_amount_credited;
    double tariff_annual_hcr_percent_change;

public:
    Scenario();

    QStringList getDyn_alloc_sce() const;
    std::vector<std::string> getDyn_alloc_sce_asVector() const;

    void setDyn_alloc_sce(const QStringList &value);
    QStringList getDyn_pop_sce() const;
    std::vector<std::string> getDyn_pop_sce_asVector() const;

    void setDyn_pop_sce(const QStringList &value);
    QString getBiolsce() const;
    QString getFleetsce() const;
    void setBiolsce(const QString &value);
    void setFleetsce(const QString &value);
    int getFreqDoGrowth() const;
    void setFreqDoGrowth(int value);
    int  getFreqDispatchThePop() const;
    void setFreqDispatchThePop(int value);
    int getGraph() const;
    void setGraph(int value);
    int getNrow_coord() const;
    void setNrow_coord(int value);
    int getNrow_graph() const;
    void setNrow_graph(int value);
    types::NodeId getA_port() const;
    void setA_port(types::NodeId value);
    void setGraph_res(const QStringList &value);
    QStringList getGraph_res() const;
    bool getIs_individual_vessel_quotas() const;
    void setIs_individual_vessel_quotas(bool value);
    bool getIs_check_all_stocks_before_going_fishing() const;
    void setIs_check_all_stocks_before_going_fishing(bool value);

    bool isDtreesEnabled() const { return use_dtrees; }
    void setDtreesEnabled(bool en) { use_dtrees = en; }

    bool save (QString path, QString modelname, QString outputname, QString *error);

    static Scenario readFromFile (QString path, QString modelname, QString outputname);

    QString getDtGoFishing() const;
    void setDtGoFishing(const QString &dtGoFishing);
    QString getDtChooseGround() const;
    void setDtChooseGround(const QString &dtChooseGround);
    QString getDtStartFishing() const;
    void setDtStartFishing(const QString &dtStartFishing);
    QString getDtChangeGround() const;
    void setDtChangeGround(const QString &dtChangeGround);
    QString getDtStopFishing() const;
    void setDtStopFishing(const QString &dtStopFishing);
    QString getDtChangePort() const;
    void setDtChangePort(const QString &dtChangePort);

    std::vector<double>  getGraph_res_asVector() const;
    std::vector<int> getTariffPop_asVector() const;

    void setTariffPop(const QStringList &value);
    int getFreqUpdateTariffCode() const;
    int getUpdateTariffsBasedOnLpueOrDpueCode() const;
    void setFreqUpdateTariffCode(int value);
    void setUpdateTariffsBasedOnLpueOrDpueCode(int value);
    std::vector<double> getArbitraryBreaksForTariff_asVector() const;
    void setArbitraryBreaksForTariff(const QStringList &value);
    int getTotalAmountCredited() const;
    void setTotalAmountCredited(int value);
    double getTariffAnnualHcrPercentChange() const;
    void setTariffAnnualHcrPercentChange(double value);



};

#endif // SCENARIO_H