IZColor.hpp

#ifndef OPALS_IZCOLOR_HPP_INCLUDED
#define OPALS_IZCOLOR_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/String.hpp>
#include <opals/ZColorLegend.hpp>
#include <opals/ZColorScalePal.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/GridLimit.hpp>
#include <opals/Path.hpp>

typedef opals::Array<float,2> ArrayF2;

namespace opals {

  namespace opts
  {
    namespace ZColor
    {
      /// Options of \ref ModuleZColor
      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::pixelSize, false, float >, Cons<
        ILeaf< Names::interval, false, opals::Vector<float> >, Cons<
        ILeaf< Names::nClasses, false, unsigned >, Cons<
        ILeaf< Names::palFile, false, opals::Path >, Cons<
        ILeaf< Names::legend, false, opals::ZColorLegend >, Cons<
        ILeaf< Names::scalePal, false, opals::ZColorScalePal >, Cons<
        ILeaf< Names::offsetPal, false, float >, Cons<
        ILeaf< Names::zRange, false, ArrayF2 >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::resampling, false, opals::ResamplingMethod::Type >, Cons<
        ILeaf< Names::band, false, unsigned >
      > > > > > > > > > > > > > > > Options;
    }
  }

  /// Derives color coded visualizations of grid models and stores them as geo-coded raster images.
  /** TODO: 
      More details on opalsZColor */
  /// \see \ref ModuleZColor
  class OPALS_API IZColor : virtual public IModuleBase
  {

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

    virtual ~IZColor() {}

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

  };

};

#endif