ISpatialQueryDescriptor.hpp

#ifndef DM_ISPATIAL_QUERY_DESCRIPTOR_HPP_INCLUDED
#define DM_ISPATIAL_QUERY_DESCRIPTOR_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/IKnnQueryDescriptor.hpp"
#include "DM/IGeometry.hpp"
#include "DM/AutoLink.hpp" //enable autolink

DM_NAMESPACE_BEGIN

struct SortOrder {
  enum Type {
    unsorted, ///< results are in unspecified order
    asc2d,    ///< results are sorted ascending by 2d distance from query position
    asc3d,    ///< results are sorted ascending by 3d distance from query position
  };
};

/// enum for ordering the spatial search strategies
struct QueryOrder {
  enum Type {
    undefined,        ///< initial value or in case only one query is defined
    knnFirst,         ///< do knn search first and 'filter' knn results with region query
    regionQueryFirst  ///< do region query first and 'sort/filter' results  based on the defined knn search
  };
};


class DM_API ISpatialQueryDescriptor : public ObjectBase
{
public:
  /// \brief create a new spatial query descriptor object
  /** In case of knn queries the point are always sorted by the distance in ascending order (2d distances in case of 2d knn query 
      and 3d distances in case of 3d knn query). Hence it is not necessary to speicify a sorting order parameter.
  */
  static ISpatialQueryDescriptor* New(KnnQueryDescriptorHandle knnQuery, SortOrder::Type sort = SortOrder::unsorted);
  static ISpatialQueryDescriptor* New(GeometryHandle regionQuery, SortOrder::Type sort = SortOrder::unsorted);
  /// perform knn search and than region query (\see QueryOrder::knnFirst)
  static ISpatialQueryDescriptor* New(KnnQueryDescriptorHandle knnQuery, GeometryHandle regionQuery, SortOrder::Type sort = SortOrder::unsorted);
  /// perform region query and than knn search (\see QueryOrder::regionQueryFirst)
  static ISpatialQueryDescriptor* New(GeometryHandle regionQuery, KnnQueryDescriptorHandle knnQuery, SortOrder::Type sort = SortOrder::unsorted);

protected:
  virtual ~ISpatialQueryDescriptor() {}

public:
  virtual QueryOrder::Type order() const = 0;

  virtual bool hasKnnQuery() const = 0;
  virtual KnnQueryDescriptorHandle getKnnQuery() const = 0;

  virtual bool hasRegionQuery() const = 0;
  virtual GeometryHandle getRegionQuery() const = 0;

  virtual bool requiresSorting() const = 0;
  virtual SortOrder::Type getSortingOrder() const = 0;
};
typedef Handle< ISpatialQueryDescriptor > SpatialQueryDescriptorHandle;

DM_NAMESPACE_END

#endif //DM_ISPATIAL_QUERY_DESCRIPTOR_HPP_INCLUDED