IDiff.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#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>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsDiff_d.lib")
  #else
      #pragma comment(lib, "opalsDiff.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleDiff
    namespace Diff
    {
      /// Options of \ref ModuleDiff
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Array<Path,2>  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::oFormat, false, String  >,
          ILeaf< Names::gridSize, false, double  >,
          ILeaf< Names::noData, false, double  >,
          ILeaf< Names::limit, false, GridLimit  >,
          ILeaf< Names::applyTrafo, false, ApplyTrafo  >,
          ILeaf< Names::trafo, false, TrafPars3dAffine  >,
          ILeaf< Names::resampling, false, ResamplingMethod  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::Diff::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};