IInfo.hpp

#ifndef OPALS_IINFO_HPP_INCLUDED
#define OPALS_IINFO_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/HeaderFeature.hpp>
#include <opals/DataSetStats.hpp>

namespace opals {

  namespace opts
  {
    namespace Info
    {
      /// Options of \ref ModuleInfo
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::statistic, true, opals::DataSetStats >, Cons<
        ILeaf< Names::exportHeader, false, opals::Vector<opals::HeaderFeature::Type> >
      > > > > Options;
    }
  }

  /// Extracts and reports header information of a vector or raster file (ODM, GDAL).
  /** opalsInfo extracts statistic information (number of points/lines/polygons, the bounding box, attribute information, spatial index details, etc..) from a data set input file. Currently, only ODMs are supported. However, the support of vector files, grid and tin file formats is planned for the future. In general, all information provided in the header of the file format is made available through a generic file statistics object. */
  /// \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.
    ///@{
    typedef opts::Info::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif