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

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Array.hpp>
#include <opals/Filter.hpp>
#include <opals/Path.hpp>
#include <opals/String.hpp>
#include <opals/TrafPars3dAffine.hpp>
#include <opals/Vector.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsExport_d.lib")
  #else
      #pragma comment(lib, "opalsExport.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleExport
    namespace Export
    {
      /// Options of \ref ModuleExport
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Vector<Path>  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::oFormat, false, String  >,
          ILeaf< Names::filter, false, Vector< FilterWithPlaceHolders<DM::IFilter::ReadAccess::coordinatesAttributes, DM::IFilter::WriteAccess::full> >  >,
          ILeaf< Names::trafo, false, TrafPars3dAffine  >,
          ILeaf< Names::restoreOrder, false, bool  >,
          ILeaf< Names::limit, false, Array<double, 4>  >,
          ILeaf< Names::tileSize, false, double  >
        >;
    }
  }
 
  /// Exports vector data stored in an OPALS data manager (ODM) in various data formats.
  /** TODO: 
      More details on opalsExport */
  /// \see \ref ModuleExport
  class OPALS_API IExport : virtual public IModuleBase
  {
 
  public:
    static IExport* New();
    static IExport* New( IControlObject &controlObject );
    static IExport* New( const IModuleBase &parent );
    static IExport* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IExport() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Export::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};