ISnellius.hpp

#ifndef OPALS_ISNELLIUS_HPP_INCLUDED
#define OPALS_ISNELLIUS_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <opals/NormalsMetaInfo.hpp>

#if !defined(OPALS_EXPORTS) && !defined(OPALS_MODULE_EXPORTS)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsSnellius_d.lib")
  #else
      #pragma comment(lib, "opalsSnellius.lib")
  #endif
#endif

#include <opals/Path.hpp>
#include <opals/Vector.hpp>

namespace opals {

  namespace opts
  {
    namespace Snellius
    {
      /// Options of \ref ModuleSnellius
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::refModel, false, opals::Path >, Cons<
        ILeaf< Names::refractiveIndex, false, double >, Cons<
        ILeaf< Names::oriFile, false, opals::Path >, Cons<
        ILeaf< Names::oriFormat, false, opals::String >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::storeMetaInfo, false, opals::NormalsMetaInfo::Type >
      > > > > > > > > > Options;
    }
  }

  /// 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.
    ///@{
    typedef opts::Snellius::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif