IZColor.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/ZColorLegend.hpp>
#include <opals/ZColorScalePal.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/GridLimit.hpp>
#include <opals/Path.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsZColor_d.lib")
  #else
      #pragma comment(lib, "opalsZColor.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleZColor
    namespace ZColor
    {
      /// Options of \ref ModuleZColor
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Path  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::oFormat, false, String  >,
          ILeaf< Names::pixelSize, false, float  >,
          ILeaf< Names::interval, false, Vector<float>  >,
          ILeaf< Names::nClasses, false, unsigned  >,
          ILeaf< Names::palFile, false, Path  >,
          ILeaf< Names::legend, false, ZColorLegend  >,
          ILeaf< Names::scalePal, false, ZColorScalePal  >,
          ILeaf< Names::offsetPal, false, float  >,
          ILeaf< Names::zRange, false, Array<float, 2>  >,
          ILeaf< Names::limit, false, GridLimit  >,
          ILeaf< Names::resampling, false, ResamplingMethod  >,
          ILeaf< Names::band, false, String  >,
          ILeaf< Names::createAlpha, false, bool  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::ZColor::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};