ISnellius.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/NormalsMetaInfo.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/Calculator.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsSnellius_d.lib")
  #else
      #pragma comment(lib, "opalsSnellius.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleSnellius
    namespace Snellius
    {
      /// Options of \ref ModuleSnellius
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::outFile, false, Path  >,
          IValue< Names::refModel, false, Path  >,
          IValue< Names::refractiveIndex, false, opals::Vector<double>  >,
          IValue< Names::oriFile, false, Path  >,
          IValue< Names::oriFormat, false, String  >,
          IValue< Names::filter, false, String  >,
          IValue< Names::setAttribute, false, Calculator<DM::ICalculator::ReadAccess::vectors, DM::ICalculator::WriteAccess::attributes>  >,
          IValue< Names::storeMetaInfo, false, NormalsMetaInfo  >
        >;
    }
  }
 
  /// Performs range and refraction corrections of raw laser bathymetry measurements according to Snell's law.
  /** TODO: 
      More details on opalsSnellius with much more words,
      possibly on several lines. */
  /// \see \ref ModuleSnellius
  class OPALS_API ISnellius : virtual public IModuleBase
  {
 
  public:
    static ISnellius* New();
    static ISnellius* New( IControlObject &controlObject );
    static ISnellius* New( const IModuleBase &parent );
    static ISnellius* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~ISnellius() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Snellius::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};