IGrid.hpp

#ifndef OPALS_IGRID_HPP_INCLUDED
#define OPALS_IGRID_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <opals/GridInterpolator.hpp>
#include <opals/GridFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/SelectionMode.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>

#if !defined(OPALS_EXPORTS) && !defined(OPALS_MODULE_EXPORTS)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsGrid_d.lib")
  #else
      #pragma comment(lib, "opalsGrid.lib")
  #endif
#endif

namespace opals {

  namespace opts
  {
    namespace Grid
    {
      /// Options of \ref ModuleGrid
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::outFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::tileSize, false, unsigned >, Cons<
        ILeaf< Names::gridSize, false, double >, Cons<
        ILeaf< Names::attribute, false, opals::String >, Cons<
        ILeaf< Names::interpolation, false, opals::GridInterpolator::Type >, Cons<
        ILeaf< Names::neighbours, false, int >, Cons<
        ILeaf< Names::searchRadius, false, double >, Cons<
        ILeaf< Names::selMode, false, opals::SelectionMode::Type >, Cons<
        ILeaf< Names::weightFunc, false, opals::String >, Cons<
        ILeaf< Names::feature, false, opals::Vector<opals::GridFeature::Type> >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::multiBand, false, bool >, Cons<
        ILeaf< Names::extrapolationCheck, false, bool >
      > > > > > > > > > > > > > > > > > Options;
    }
  }

  /// Derives a 2.5D digital elevation models (DEM) in regular grid structure using simple interpolation techniques.
  /** TODO: 
      More details on opalsGrid */
  /// \see \ref ModuleGrid
  class OPALS_API IGrid : virtual public IModuleBase
  {

  public:
    static IGrid* New();
    static IGrid* New( IControlObject &controlObject );
    static IGrid* New( const IModuleBase &parent );
    static IGrid* New( const IModuleBase &parent, IControlObject &controlObject );

    virtual ~IGrid() {}

    /// \name Access to module-specific options.
    ///@{
    typedef opts::Grid::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif