ISection.hpp
1 #pragma once
2 
3 #include <opals/IModuleBase.hpp>
4 #include <opals/Path.hpp>
5 #include <opals/Vector.hpp>
6 #include <opals/String.hpp>
7 #include <opals/Array.hpp>
8 
9 #if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
10  #if defined _DEBUG && !defined OPALS_NO_DEBUG
11  #pragma comment(lib, "opalsSection_d.lib")
12  #else
13  #pragma comment(lib, "opalsSection.lib")
14  #endif
15 #endif
16 
17 namespace opals {
18 
19  namespace opts
20  {
21  /// Options of \ref ModuleSection
22  namespace Section
23  {
24  /// Options of \ref ModuleSection
25  using Options =
26  IGroup< Names::_, false,
37  >;
38  }
39  }
40 
41  /// Extracts sections of user defined width/length along a specified reference axis from a point cloud (ODM).
42  /** TODO:
43  More details on opalsSection with much more words,
44  possibly on several lines. */
45  /// \see \ref ModuleSection
46  class OPALS_API ISection : virtual public IModuleBase
47  {
48 
49  public:
50  static ISection* New();
51  static ISection* New( IControlObject &controlObject );
52  static ISection* New( const IModuleBase &parent );
53  static ISection* New( const IModuleBase &parent, IControlObject &controlObject );
54 
55  virtual ~ISection() {}
56 
57  /// \name Access to module-specific options.
58  ///@{
60  virtual Options& opts() = 0;
61  virtual const Options& opts() const = 0;
62  ///@}
63 
64  };
65 
66 };
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, Path >, ILeaf< Names::gridFile, false, Vector< Path > >, ILeaf< Names::axisFile, false, Path >, ILeaf< Names::sectionRange, false, Vector< double > >, ILeaf< Names::patchSize, false, Array< double, 2 > >, ILeaf< Names::overlap, false, double >, ILeaf< Names::attribute, false, String >, ILeaf< Names::tileSize, false, unsigned >, ILeaf< Names::outGeometry, true, Vector< String > >, ILeaf< Names::filter, false, String > > Options
Options of Module Section.
Definition: ISection.hpp:37
Extracts sections of user defined width/length along a specified reference axis from a point cloud (O...
Definition: ISection.hpp:46
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