IAlgebra.hpp

#ifndef OPALS_IALGEBRA_HPP_INCLUDED
#define OPALS_IALGEBRA_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/ResamplingMethod.hpp>
#include <opals/MultiGridLimit.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>

typedef opals::Array<int,2> ArrayI2;
typedef opals::Array<double,6> ArrayD6;

namespace opals {

  namespace opts
  {
    namespace Algebra
    {
      /// Options of \ref ModuleAlgebra
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::formula, false, opals::String >, Cons<
        ILeaf< Names::gridSize, false, opals::Vector<double> >, Cons<
        ILeaf< Names::noData, false, double >, Cons<
        ILeaf< Names::limit, false, opals::MultiGridLimit >, Cons<
        ILeaf< Names::resampling, false, opals::ResamplingMethod::Type >, Cons<
        ILeaf< Names::maxMemory, false, unsigned >, Cons<
        ILeaf< Names::skipVoidAreas, false, bool >
      > > > > > > > > > > > Options;
    }
  }

  /// Provides a generic raster algebra calculator featuring mathematical, statistical and conditional operators.
  /** Multiple input rasters are combined by means of a generic, user defined formula
      If necessary, automatical resampling (nearest, bilinear, bicubic) is performed on the fly */
  /// \see \ref ModuleAlgebra
  class OPALS_API IAlgebra : virtual public IModuleBase
  {

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

    virtual ~IAlgebra() {}

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

  };

};

#endif