IPolylineIndex.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/Iterator.hpp"
#include "DM/IGeometry.hpp"
#include "DM/IIndexStats.hpp"
#include "DM/IBox.hpp"
#include "DM/SpatialQueryMode.hpp"
 
DM_NAMESPACE_BEGIN
 
/// \brief Interface to an polyline and polygon index object managing all non point objects within the datamanager
class DM_API IPolylineIndex : public ObjectBase
{
 public:
  // Iterator typedefs ============================================================================
  typedef ConstIterator<IGeometry>    const_iterator_geometry;      ///< Geometry iterator
  typedef ConstIterator<IPolyline>    const_iterator_line;          ///< Polyline iterator
  
  typedef InsertIterator<IGeometry>   insert_iterator_geometry;     ///< Geometry insert iterator (used in searchGeometry functions)
  typedef InsertIterator<IPolyline>   insert_iterator_line;         ///< Polyline insert iterator (used in searchPolyline functions)
 
  virtual ~IPolylineIndex() {}
 
  // General memeber functions ====================================================================
  virtual BoxHandle getLimit() const = 0;
 
  virtual int64_t sizeGeometry()      const = 0;
 
  virtual int64_t sizePolyline()      const = 0;
  virtual int64_t sizePolylinePoint() const = 0;
 
  virtual int64_t sizePolygon()       const = 0;
  virtual int64_t sizePolygonPoint()  const = 0;
 
  // access functions ============================================================================
  virtual PolylineHandle getPolyline(int64_t id) const = 0;
  virtual PolygonHandle  getPolygon(int64_t id) const = 0;
  virtual GeometryHandle getGeometry(int64_t id) const = 0;
 
  // modifier functions ==========================================================================
  virtual int64_t addPolyline(PolylineHandle l) = 0;
 
  virtual void replacePolyline(PolylineHandle l) = 0;
 
  /// remove an element by its id
  virtual void remove(int64_t id) = 0;
 
  // Iterator function ============================================================================
  virtual const_iterator_geometry beginGeometry(IteratorOrder order = IteratorOrder::internal) const = 0;
  virtual const_iterator_geometry endGeometry(IteratorOrder order = IteratorOrder::internal) const = 0;
 
  virtual const_iterator_line beginPolyline(IteratorOrder order = IteratorOrder::internal) const = 0;
  virtual const_iterator_line endPolyline(IteratorOrder order = IteratorOrder::internal) const = 0;
 
  // Spatial access functions =====================================================================
  virtual void searchGeometry(const IWindow &win, SpatialQueryMode mode, insert_iterator_geometry &instIt,        bool includeRightBoundary = true) = 0;
  virtual void searchGeometry(const IBox &box,    SpatialQueryMode mode, insert_iterator_geometry &instIt,        bool includeRightBoundary = true) = 0;
  virtual void searchGeometry(const IPolygon &p,  SpatialQueryMode mode, insert_iterator_geometry &instIt) = 0;
 
  /// \brief k nearest neighbour search
  /// \param[in]  nnCount       number of k neighbour to find
  /// \param[in]  queryPt       base point for the neighbour search
  /// \param[in]  instIt        insert iterator for collecting the found geometry objects
  /// \param[in]  maxDistance   maximum distance (not squared distance) for finding geometry objects (use -1 disabling the distance limit)
  /// \return distance to the furthest found geometry object or 'maxDistance' in case on object was found
  virtual double searchGeometry(int nnCount, const IPoint &queryPt, insert_iterator_geometry &instIt, 
                                double maxDistance = -1) = 0;
 
  // Statistics memeber functions ====================================================================
  virtual IndexStatsHandle        getIndexStatistics() const = 0;
};
 
typedef Handle< IPolylineIndex > PolylineIndexHandle;
 
DM_NAMESPACE_END