objecttreemodel.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.
// --------------------------------------------------------------------------

#ifndef OBJECTTREEMODEL_H
#define OBJECTTREEMODEL_H

#include <QAbstractItemModel>
#include <QList>

class DisplaceModel;
class MapObjectsController;
class StatsController;

namespace objecttree {
class ObjectTreeEntity;
class FFarmTypesEntity;
class BFunctionalGroupsEntity;
class WFarmTypesEntity;
class ShipTypesEntity;
}

class ObjectTreeModel : public QAbstractItemModel
{
    Q_OBJECT

public:
    enum Category {
        Layers = 0,
        ShapefileLayers,
        EnvLayers,
        OutputLayers,
        TariffsLayers,
        Nodes, Populations, SizeGroups,  Benthos, BenthosFunctionalGroups,
        Nations, Firms, Metiers, Harbours,  Vessels,
        Ships, ShipsTypes, Fishfarms, FishfarmsTypes, Windmills, WindfarmsTypes,
        LastCategory
     };

    explicit ObjectTreeModel(MapObjectsController *map, StatsController *stats, QObject *parent = 0);

    int columnCount(const QModelIndex &parent) const;
    int rowCount(const QModelIndex &parent) const;
    QModelIndex parent(const QModelIndex &child) const;
    QModelIndex index(int row, int column, const QModelIndex &parent) const;
    QVariant data(const QModelIndex &index, int role) const;
    Qt::ItemFlags flags ( const QModelIndex & index ) const;
    bool setData ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole );

    void setCurrentModel (int idx, DisplaceModel *model);
    int getModelIdx() const { return mModelIdx; }
    DisplaceModel *getModel() const { return mModel; }
    MapObjectsController *getMapControl() const { return mMapControl; }
    StatsController *getStatsController() const { return mStatsController; }

    // For use from ObjectTreeEntities
    QModelIndex createCategoryEntity(int row, int column, Category cat) const;
    QModelIndex createCategoryEntityFromChild (Category cat) const;
    QModelIndex createEntity (int row, int column, objecttree::ObjectTreeEntity *entity) const;

    bool isObject(QModelIndex index) const;
    Category getCategory (QModelIndex index) const;
    objecttree::ObjectTreeEntity *entity (const QModelIndex &index) const;

    void refresh();
signals:

public slots:

private:
    MapObjectsController *mMapControl;
    StatsController *mStatsController;
    DisplaceModel *mModel;
    int mModelIdx;

    objecttree::FFarmTypesEntity *farmtypes;
    objecttree::BFunctionalGroupsEntity *funcgroups;
    objecttree::WFarmTypesEntity *windfarmtypes;
    objecttree::ShipTypesEntity *shiptypes;

protected:
    // helper functions

    bool isRootLevel (const QModelIndex &level) const {
        return !level.isValid();
    }

    bool isCategoryLevel (const QModelIndex &level) const { // level.internalId() > 0 && level.internalId() < LastCategory
        return level.isValid() &&
                (level.row() < entityTemplates.size() &&
                     level.internalPointer() == entityTemplates[level.row()]);
    }

    static QList<objecttree::ObjectTreeEntity *> entityTemplates;
    static QString entityNames[];
};

#endif // OBJECTTREEMODEL_H