IDBH.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/String.hpp>
#include <opals/Vector.hpp>
#include <opals/DBHModel.hpp>
#include <opals/StemModel.hpp>
#include <opals/Calculator.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsDBH_d.lib")
  #else
      #pragma comment(lib, "opalsDBH.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleDBH
    namespace DBH
    {
      /// Options of \ref ModuleDBH
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Path  >,
          ILeaf< Names::approxFile, false, Path  >,
          ILeaf< Names::aFormat, false, String  >,
          ILeaf< Names::filter, false, String  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::weightFunc, false, String  >,
          ILeaf< Names::geometryModel, false, DBHModel  >,
          ILeaf< Names::patchLength, false, double  >,
          ILeaf< Names::overlap, false, double  >,
          ILeaf< Names::trace, false, Vector<bool>  >,
          ILeaf< Names::searchRadius, false, Calculator<DM::ICalculator::ReadAccess::attributes, DM::ICalculator::WriteAccess::none>  >,
          ILeaf< Names::outResults, true, Vector<StemModel>  >,
          ILeaf< Names::byproduct, false, Path  >,
          ILeaf< Names::tileSize, false, double  >
        >;
    }
  }
 
  /// Estimate the Diameter at Breast Height (DBH) based on 3D point cloud data (ODM).
  /** TODO: 
      More details on opalsDBH with much more words,
      possibly on several lines. */
  /// \see \ref ModuleDBH
  class OPALS_API IDBH : virtual public IModuleBase
  {
 
  public:
    static IDBH* New();
    static IDBH* New( IControlObject &controlObject );
    static IDBH* New( const IModuleBase &parent );
    static IDBH* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IDBH() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::DBH::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};