IndexDescription.hpp

#pragma once
 
#include "opals/config.hpp"
#include "opals/String.hpp"
#include "opals/IndexType.hpp"
 
namespace opals
{
 
  /// \brief  IndexDescription provides generic information about a spatial index (used by DataSetStats).
  ///
  /// If a specific information is really set, can be retrieved by the corresponding isSet function. 
  /// Depending on the data type a specific no data value is used to indicate unset values.
  ///           
  /// \author JO
  /// \date   20.06.2012
  class OPALS_API IndexDescription
  {
  public:
    IndexDescription();
    virtual ~IndexDescription();
 
    void reset();
 
    bool isSetDimension() const;
    bool isSetType() const;
    bool isSetDepth() const;
    bool isSetCountNode() const;
    bool isSetCountLeaf() const;
    bool isSetTileSize() const;
    bool isSetObjectsInLeafMin() const;
    bool isSetObjectsInLeafMax() const;
    bool isSetObjectsInLeafMean() const;
    bool isSetObjectsInLeafStd() const;
 
    bool containsPoints() const;
    bool containsLines() const;
    bool containsPolygons() const;
 
    int             getDimension() const;
    IndexType getType() const;
    int             getDepth() const;
    int             getCountNode() const;
    int             getCountLeaf() const;
    double          getTileSize() const;
    long long       getObjectsInLeafMin() const;
    long long       getObjectsInLeafMax() const;
    double          getObjectsInLeafMean() const;
    double          getObjectsInLeafStd() const;
 
    void setGeometries(bool ContainsPoints, bool ContainsLines, bool ContainsPolygons);
 
    void setDimension(const int &Dim);
    void setType(const IndexType &Type);
    void setDepth(const int& Depth);
    void setCountNode(const int& LeafCount);
    void setCountLeaf(const int& LeafCount);
    void setTileSize(const double& TileSize);
    void setObjectsInLeafMin(const long long& min);
    void setObjectsInLeafMax(const long long& max);
    void setObjectsInLeafMean(const double& mean);
    void setObjectsInLeafStd(const double& stddev);
 
    // output functions
    String logIndexDescription(int precision = 3) const;   ///< for xml output
    String printIndexDescription() const; ///< for log output (in more readable format)
 
    static String printIndexHeader();     ///< for log the header line 
 
  private:
    int             dimension;
    IndexType type;
    int             depth;
    bool            hasPoints;
    bool            hasLines;
    bool            hasPolygons;
    int             countLeaf;
    int             countNode;
    double          tileSize;
    long long       objectsInLeafMin;
    long long       objectsInLeafMax;
    double          objectsInLeafMean;
    double          objectsInLeafStd;
  };
}