c++_api/inc/opals/IAddInfo.hpp

#ifndef OPALS_IADDINFO_HPP_INCLUDED
#define OPALS_IADDINFO_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

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

namespace opals {

  namespace opts
  {
    namespace AddInfo
    {
      /// Options of \ref ModuleAddInfo
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::attribute, false, opals::String >, Cons<
        ILeaf< Names::gridFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::tilePointCount, false, unsigned >, Cons<
        ILeaf< Names::neighbours, false, int >, Cons<
        ILeaf< Names::searchRadius, false, double >, Cons<
        ILeaf< Names::selMode, false, opals::SelectionMode::Type >, Cons<
        ILeaf< Names::searchMode, false, opals::SearchMode::Type >, Cons<
        ILeaf< Names::filter, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::resampling, false, opals::ResamplingMethod::Type >
      > > > > > > > > > > > Options;
    }
  }

  /// Inserts or updates ODM attributes by combining existing attributes and/or grid models.
  /** AddInfo constitutes a very general and flexible tool for creating 
      new or updating existing point attributes by combining point attributes 
      and/or grid models (grid values interpolated at the point locations). */
  /// \see \ref ModuleAddInfo
  class OPALS_API IAddInfo : virtual public IModuleBase
  {

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

    virtual ~IAddInfo() {}

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

  };

};

#endif