IQuerySort.hpp

#pragma once
 
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp" 
#include "DM/IAddInfoLayout.hpp"
 
DM_NAMESPACE_BEGIN
 
 
/// \brief For defining post spatial query sorting
class DM_API IQuerySort : public ObjectBase
{
public:
  enum struct SortMode
  {
    distance2d = -5,
    distance3d = -4,
    coor_x = -3,
    coor_y = -2,
    coor_z = -1,
    standard = distance3d,
    attribute = 1  ///< attribute defined by a single column layout
  };
 
  enum struct SortOrder
  {
    ascending = 0,
    descending = 1
  };
 
  static IQuerySort *New(SortMode mode, SortOrder order = SortOrder::ascending, const AddInfoLayoutHandle &layout = AddInfoLayoutHandle());
 
protected:
  virtual ~IQuerySort() {}
 
public:
  virtual bool isDistanceBased() const = 0;
  virtual bool isAttributeBased() const = 0;
  virtual bool isCoordianteBased() const = 0;
 
  virtual SortMode  mode() const = 0;
  virtual SortOrder order() const = 0;
  virtual const AddInfoLayoutHandle& layout() const = 0;
 
  virtual void mode(SortMode m) = 0;
  virtual void order(SortOrder o) = 0;
  virtual void layout(const AddInfoLayoutHandle& l) = 0;
 
  /// get an object copy
  virtual IQuerySort* clone() const = 0;
};
 
typedef Handle< IQuerySort > QuerySortHandle;
 
DM_NAMESPACE_END