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

#ifndef OPALS_IEXPORT_HPP_INCLUDED
#define OPALS_IEXPORT_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

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

typedef opals::Array<double,4>    ArrayD4;

namespace opals {

  namespace opts
  {
    namespace Export
    {
      /// Options of \ref ModuleExport
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::trafo, false, opals::TrafPars3dAffine >, Cons<
        ILeaf< Names::restoreOrder, false, bool >, Cons<
        ILeaf< Names::limit, false, ArrayD4 >, Cons<
        ILeaf< Names::tileSize, false, double >
      > > > > > > > > > Options;
    }
  }

  /// 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.
    ///@{
    typedef opts::Export::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif