IContouring.hpp
1 #pragma once
2 
3 #include <opals/IModuleBase.hpp>
4 #include <opals/String.hpp>
5 #include <opals/Path.hpp>
6 #include <opals/Vector.hpp>
7 
8 #if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
9  #if defined _DEBUG && !defined OPALS_NO_DEBUG
10  #pragma comment(lib, "opalsContouring_d.lib")
11  #else
12  #pragma comment(lib, "opalsContouring.lib")
13  #endif
14 #endif
15 
16 namespace opals {
17 
18  namespace opts
19  {
20  /// Options of \ref ModuleContouring
21  namespace Contouring
22  {
23  /// Options of \ref ModuleContouring
24  using Options =
25  IGroup< Names::_, false,
31  >;
32  }
33  }
34 
35  /// Derives the contour of foreground objects of a raster model and exports the results as a polygon shape file.
36  /** TODO:
37  More details on opalsContouring */
38  /// \see \ref ModuleContouring
39  class OPALS_API IContouring : virtual public IModuleBase
40  {
41 
42  public:
43  static IContouring* New();
44  static IContouring* New( IControlObject &controlObject );
45  static IContouring* New( const IModuleBase &parent );
46  static IContouring* New( const IModuleBase &parent, IControlObject &controlObject );
47 
48  virtual ~IContouring() {}
49 
50  /// \name Access to module-specific options.
51  ///@{
53  virtual Options& opts() = 0;
54  virtual const Options& opts() const = 0;
55  ///@}
56 
57  };
58 
59 };
Derives the contour of foreground objects of a raster model and exports the results as a polygon shap...
Definition: IContouring.hpp:39
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
Interface for retrieving status and progress information from a module run.
Definition: c++_api/inc/opals/IControlObject.hpp:30
IGroup< Names::_, false, ILeaf< Names::inFile, false, Path >, ILeaf< Names::outFile, false, Path >, ILeaf< Names::contours, true, Vector< String > >, ILeaf< Names::minArea, false, double >, ILeaf< Names::compressCollinear, false, bool > > Options
Options of Module Contouring.
Definition: IContouring.hpp:31
A group of options.
Definition: IOption.hpp:108