IOpenness.hpp

#ifndef OPALS_IOPENNESS_HPP_INCLUDED
#define OPALS_IOPENNESS_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/GridLimit.hpp>
#include <opals/OpennessFeature.hpp>

namespace opals {

  namespace opts
  {
    namespace Openness
    {
      /// Options of \ref ModuleOpenness
      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::feature, false, opals::OpennessFeature::Type >, Cons<
        ILeaf< Names::selMode, false, int >, Cons<
        ILeaf< Names::kernelSize, false, int >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::noData, false, float >
      > > > > > > > > > Options;
    }
  }

  /// Provides a raster map of local viewsheds (i.e. openness) based on a DTM grid model.
  /** TODO: 
      More details on opalsOpenness with much more words,
      possibly on several lines. */
  /// \see \ref ModuleOpenness
  class OPALS_API IOpenness : virtual public IModuleBase
  {

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

    virtual ~IOpenness() {}

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

  };

};

#endif