IEchoRatio.hpp

#ifndef OPALS_IECHORATIO_HPP_INCLUDED
#define OPALS_IECHORATIO_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/EchoRatioMode.hpp>

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

namespace opals {

  namespace opts
  {
    namespace EchoRatio
    {
      /// Options of \ref ModuleEchoRatio
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::searchRadius, false, float >, Cons<
        ILeaf< Names::ratioMode, false, opals::EchoRatioMode::Type >, Cons<
        ILeaf< Names::filter, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::maxSigma, false, float >
      > > > > > > Options;
    }
  }

  /// Derives and stores the echo ratio (ER) attribute for points of an OPALS data manager.
  /** TODO: 
      More details on opalsEchoRatio */
  /// \see \ref ModuleEchoRatio
  class OPALS_API IEchoRatio : virtual public IModuleBase
  {

  public:
    static IEchoRatio* New();
    static IEchoRatio* New( IControlObject &controlObject );
    static IEchoRatio* New( const IModuleBase &parent );
    static IEchoRatio* New( const IModuleBase &parent, IControlObject &controlObject );

    virtual ~IEchoRatio() {}

    /// \name Access to module-specific options.
    ///@{
    typedef opts::EchoRatio::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif