mapgrid.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 MAPGRID_H
#define MAPGRID_H
#include <QtCore/QHash>
#include <QRectF>
#include "grid.h"
#include "gisgrid.h"
class ResourceUnit; // forward
class Tree; // forward
class SaplingTreeOld; // forward
class ResourceUnitSpecies; // forward
 
class MapGrid
{
public:
    MapGrid();
    MapGrid(const GisGrid &source_grid) { loadFromGrid(source_grid); }
    MapGrid(const QString &fileName, const bool create_index=true) { loadFromFile(fileName, create_index); }
    bool loadFromFile(const QString &fileName, const bool create_index=true); 
    bool loadFromGrid(const GisGrid &source_grid, const bool create_index=true); 
    void createEmptyGrid(); 
    void createIndex(); 
 
    // access
    const QString &name() const { return mName; }
    bool isValid() const { return !mGrid.isEmpty(); }
    const Grid<int> &grid() const { return mGrid; }
    int count() const { return mRectIndex.size(); }
    // access
    bool isValid(const int id) const { return mRectIndex.contains(id); }
    QRectF boundingBox(const int id) const { return isValid(id)?mRectIndex[id].first: QRectF(); } 
    double area(const int id) const {return isValid(id)?mRectIndex[id].second : 0.;} 
    QList<ResourceUnit*> resourceUnits(const int id) const;
    QList<QPair<ResourceUnit*, double> > resourceUnitAreas(const int id) const { return mRUIndex.values(id); }
    QList<Tree*> trees(const int id) const;
    int loadTrees(const int id,  QVector<QPair<Tree *, double> > &rList, const QString filter=QString(), int n_estimate=0) const;
    static void freeLocksForStand(const int id);
    QList<int> gridIndices(const int id) const;
    const QMultiHash<int, int> neighborList() const { return mNeighborList; }
    void updateNeighborList(); 
    QList<int> neighborsOf(const int index) const;
    inline bool hasValue(const int id, const QPoint &lif_grid_coords) const { return mGrid.constValueAtIndex(lif_grid_coords.x()/cPxPerHeight, lif_grid_coords.y()/cPxPerHeight) == id; }
    inline int standIDFromLIFCoord(const QPoint &lif_grid_coords) const  { return mGrid.constValueAtIndex(lif_grid_coords.x()/cPxPerHeight, lif_grid_coords.y()/cPxPerHeight); }
 
private:
    QString mName; 
    Grid<int> mGrid;
    QHash<int, QPair<QRectF,double> > mRectIndex; 
    QMultiHash<int, QPair<ResourceUnit*, double> > mRUIndex; 
    QMultiHash<int, int> mNeighborList; 
};
 
#endif // MAPGRID_H