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

#ifndef OPALS_IIMPORT_HPP_INCLUDED
#define OPALS_IIMPORT_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/TrafPars3dAffine.hpp>
#include <opals/BeamInfo.hpp>
#include <opals/MergePolygonMode.hpp>

namespace opals {

  namespace opts
  {
    namespace Import
    {
      /// Options of \ref ModuleImport
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::iFormat, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::trjFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::tFormat, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::trafo, false, opals::TrafPars3dAffine >, Cons<
        ILeaf< Names::storeOrder, false, bool >, Cons<
        ILeaf< Names::tilePointCount, false, int >, Cons<
        ILeaf< Names::tileSize, false, double >, Cons<
        ILeaf< Names::storeBeamInfo, false, opals::Vector<opals::BeamInfo::Type> >, Cons<
        ILeaf< Names::mergePolygon, false, opals::MergePolygonMode::Type >
      > > > > > > > > > > > > > Options;
    }
  }

  /// Loads vector and raster data into an ODM for subsequent use in modules dealing with point cloud and line related data.
  /** Module Import tries to preserve the full information of imported file formats.
      Therefore, the ODM contains an additional administration level, storing header and layer information for each file.
      Hence, it is possible to reproduce the original files from an ODM file (even in case of a multiple file import).
      Currently, Module Import supports 6 different vector file formats. Additionally, any of the supported raster formats may be imported. However, please notice that this is a rather rare use case: raster data imported into an ODM will be treated like any other data in an ODM i.e. the topological information defined implicitly by rasters is lost. */
  /// \see \ref ModuleImport
  class OPALS_API IImport : virtual public IModuleBase
  {

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

    virtual ~IImport() {}

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

    };

};

#endif