IInfo.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/String.hpp>
#include <opals/HeaderFeature.hpp>
#include <opals/DataSetStats.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsInfo_d.lib")
  #else
      #pragma comment(lib, "opalsInfo.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleInfo
    namespace Info
    {
      /// Options of \ref ModuleInfo
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Vector<Path>  >,
          IValue< Names::exactComputation, false, bool  >,
          IValue< Names::valueFrequency, false, Vector<String>  >,
          IValue< Names::statistic, true, Vector<DataSetStats>  >,
          IValue< Names::exportOverview, false, Vector<HeaderFeature>  >,
          IValue< Names::multiBand, false, bool  >,
          IValue< Names::merge, false, bool  >,
          IValue< Names::enduranceMode, false, bool  >,
          IGroup< Names::generateOFD,
            IValue< Names::file, false, Path  >,
            IValue< Names::format, false, String  >
          >
        >;
    }
  }
 
  /// Extracts and reports information of an ODM, vector or raster file.
  /** opalsInfo extracts statistic information (number of points/lines/polygons, the bounding box, attribute information, spatial index details, etc..) from a data set input file. The information provided in the header of the file format is made available through a generic file statistics object. Since not all data formats provide full statistic with the header, the module also provides an exact computation mode. In this mode not only the header, but the full content of the input file is read through allow extracting complete statistic information. Please note that the exact computation mode is typically much slower than the standard mode but it will report correct informations even in cases where the header information is incomplete or incorrect. */
  /// \see \ref ModuleInfo
  class OPALS_API IInfo : virtual public IModuleBase
  {
 
  public:
    static IInfo* New();
    static IInfo* New( IControlObject &controlObject );
    static IInfo* New( const IModuleBase &parent );
    static IInfo* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IInfo() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Info::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};