ISamplingStrategy.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp" 
#include "DM/StatFeature.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/IPoint.hpp"
 
DM_NAMESPACE_BEGIN
 
/// \brief Base class of all geometry objects
class DM_API ISamplingStrategy : public ObjectBase
{
public:
  enum struct FeatureReference
  {
    null = 0,
    coor_x    = 1,
    coor_y    = 2,
    coor_z    = 3,
    attribute = 4,  ///< attribute defined by a single column layout
    all       = 5       ///< when selecting all points per cell
  };
 
  /// creates an empty sampling strategy object
  static ISamplingStrategy* New();  
 
  /// sampling strategy for point based modules
  static ISamplingStrategy* New(const double &cellsize, const IPoint &refPt,
                                const StatFeature &statsFeature, FeatureReference type = FeatureReference::coor_z, const AddInfoLayoutHandle &layout = AddInfoLayoutHandle(),
                                unsigned dim = 2);
  static ISamplingStrategy* New(const double &cellsize, PointHandle refPt,
                                const StatFeature &statsFeature, FeatureReference type = FeatureReference::coor_z, const AddInfoLayoutHandle &layout = AddInfoLayoutHandle(),
                                unsigned dim = 2);
  
  /// sampling strategy for raster based modules
  static ISamplingStrategy* New(const unsigned subdivsion, 
                                const StatFeature &statsFeature, FeatureReference type = FeatureReference::coor_z, const AddInfoLayoutHandle &layout = AddInfoLayoutHandle(),
                                unsigned dim = 2);
 
protected:
  virtual ~ISamplingStrategy() {}
 
public:
  virtual ISamplingStrategy* clone() const = 0;
 
  virtual bool isRasterBased() const = 0;
  virtual bool isPointBased() const = 0;
 
  virtual bool hasCellsize() const = 0;
  virtual bool hasSubdivision() const = 0;
  virtual bool hasRefPt() const = 0;
  virtual bool hasFeature() const = 0;
  virtual bool hasFeatureReference() const = 0;
  virtual bool hasLayout() const = 0;
 
  virtual unsigned dimension() const = 0;
 
  // access function in raster based mode
  /// get sub-sampling count per output cell
  virtual unsigned subdivision() const = 0;
  virtual void subdivision(unsigned subdiv) = 0;
 
  // access function in point based mode
  /// get cell size for sub-sampling
  virtual double cellsize() const = 0;
  virtual void cellsize(double cs) = 0;
  /// get reference point of sub-sampling raster (which is a corner of raster cell) 
  virtual  const IPoint &refPt() const = 0;
  virtual  void refPt(const IPoint &refpt) = 0;
 
 
  /// check if all point data within the tiles should be kept.
  virtual bool sampleAll() const = 0;
  /// force to sample all data point within tiles
  virtual void sampleAll() = 0;
 
  /// if not all points should be kept, than the following statistics features will be applied
  virtual const StatFeature &feature() const = 0;
  virtual void feature(const StatFeature &feat) = 0;
 
  virtual FeatureReference featureReference() const = 0;
  virtual void featureReference(const FeatureReference &featRef) = 0;
 
  virtual const AddInfoLayoutHandle &layout() const = 0;
  virtual void layout(const AddInfoLayoutHandle &l) = 0;
 
  virtual const char *text() const = 0;
};
 
typedef Handle< ISamplingStrategy > SamplingStrategyHandle;
 
DM_NAMESPACE_END