IIsolines.hpp

#ifndef OPALS_IISOLINES_HPP_INCLUDED
#define OPALS_IISOLINES_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

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

typedef opals::Array<double,2> ArrayD2;

namespace opals {

  namespace opts
  {
    namespace Isolines
    {
      /// Options of \ref ModuleIsolines
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::band, false, unsigned >, Cons<
        ILeaf< Names::interval, false, double >, Cons<
        ILeaf< Names::levels, false, opals::Vector<double> >, Cons<
        ILeaf< Names::zRange, false, ArrayD2 >, Cons<
        ILeaf< Names::thinOut, false, double >, Cons<
        ILeaf< Names::closeMin, false, double >, Cons<
        ILeaf< Names::minLength, false, double >, Cons<
        ILeaf< Names::densification, false, bool >
      > > > > > > > > > > > > Options;
    }
  }

  /// Derives contour lines (isolines) from grid models and stores them as a vector dataset.
  /** TODO: 
      More details on opalsIsolines with much more words,
      possibly on several lines. */
  /// \see \ref ModuleIsolines
  class OPALS_API IIsolines : virtual public IModuleBase
  {

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

    virtual ~IIsolines() {}

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

  };

};

#endif