IDiff.hpp
1 #pragma once
2 
3 #include <opals/IModuleBase.hpp>
4 #include <opals/String.hpp>
5 #include <opals/Path.hpp>
6 #include <opals/Array.hpp>
7 #include <opals/ResamplingMethod.hpp>
8 #include <opals/GridLimit.hpp>
9 #include <opals/ApplyTrafo.hpp>
10 #include <opals/TrafPars3dAffine.hpp>
11 #include <opals/NoDataType.hpp>
12 
13 #if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
14  #if defined _DEBUG && !defined OPALS_NO_DEBUG
15  #pragma comment(lib, "opalsDiff_d.lib")
16  #else
17  #pragma comment(lib, "opalsDiff.lib")
18  #endif
19 #endif
20 
21 namespace opals {
22 
23  namespace opts
24  {
25  /// Options of \ref ModuleDiff
26  namespace Diff
27  {
28  /// Options of \ref ModuleDiff
29  using Options =
30  IGroup< Names::_, false,
41  >;
42  }
43  }
44 
45  /// Calculates a difference grid model based on either two grids or a one grid and a horizontal reference plane.
46  /** TODO:
47  More details on opalsDiff with much more words,
48  possibly on several lines. */
49  /// \see \ref ModuleDiff
50  class OPALS_API IDiff : virtual public IModuleBase
51  {
52 
53  public:
54  static IDiff* New();
55  static IDiff* New( IControlObject &controlObject );
56  static IDiff* New( const IModuleBase &parent );
57  static IDiff* New( const IModuleBase &parent, IControlObject &controlObject );
58 
59  virtual ~IDiff() {}
60 
61  /// \name Access to module-specific options.
62  ///@{
64  virtual Options& opts() = 0;
65  virtual const Options& opts() const = 0;
66  ///@}
67 
68  };
69 
70 };
Calculates a difference grid model based on either two grids or a one grid and a horizontal reference...
Definition: IDiff.hpp:50
Leaf that holds a read-only value.
Definition: IOption.hpp:63
Contains the public interface of OPALS.
Definition: AbsValueOrQuantile.hpp:8
Abstract base class of all opals modules.
Definition: IModuleBase.hpp:13
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, NoDataType >, ILeaf< Names::limit, false, GridLimit >, ILeaf< Names::applyTrafo, false, ApplyTrafo >, ILeaf< Names::trafo, false, TrafPars3dAffine >, ILeaf< Names::resampling, false, ResamplingMethod >, ILeaf< Names::band, false, String > > Options
Options of Module Diff.
Definition: IDiff.hpp:41
Interface for retrieving status and progress information from a module run.
Definition: c++_api/inc/opals/IControlObject.hpp:30
A group of options.
Definition: IOption.hpp:108