IDiff.hpp

#ifndef OPALS_IDIFF_HPP_INCLUDED
#define OPALS_IDIFF_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/GridLimit.hpp>
#include <opals/ApplyTrafo.hpp>
#include <opals/TrafPars3dAffine.hpp>

typedef opals::Array<opals::Path,2> ArrayPath2;

namespace opals {

  namespace opts
  {
    namespace Diff
    {
      /// Options of \ref ModuleDiff
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, ArrayPath2 >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::gridSize, false, double >, Cons<
        ILeaf< Names::noData, false, double >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::applyTrafo, false, opals::ApplyTrafo::Type >, Cons<
        ILeaf< Names::trafo, false, opals::TrafPars3dAffine >, Cons<
        ILeaf< Names::resampling, false, opals::ResamplingMethod::Type >
      > > > > > > > > > > Options;
    }
  }

  /// Calculates a difference grid model based on either two grids or a one grid and a horizontal reference plane.
  /** TODO: 
      More details on opalsDiff with much more words,
      possibly on several lines. */
  /// \see \ref ModuleDiff
  class OPALS_API IDiff : virtual public IModuleBase
  {

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

    virtual ~IDiff() {}

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

  };

};

#endif