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

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/SelectionMode.hpp>
#include <opals/SearchMode.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/RasterFile.hpp>
#include <opals/Vector.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsAddInfo_d.lib")
  #else
      #pragma comment(lib, "opalsAddInfo.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleAddInfo
    namespace AddInfo
    {
      /// Options of \ref ModuleAddInfo
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Path  >,
          ILeaf< Names::attribute, false, String  >,
          ILeaf< Names::gridFile, false, Vector<RasterFile>  >,
          ILeaf< Names::tilePointCount, false, unsigned  >,
          ILeaf< Names::neighbours, false, int  >,
          ILeaf< Names::searchRadius, false, double  >,
          ILeaf< Names::selMode, false, SelectionMode  >,
          ILeaf< Names::searchMode, false, SearchMode  >,
          ILeaf< Names::filter, false, Vector<String>  >,
          ILeaf< Names::resampling, false, ResamplingMethod  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::AddInfo::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};