IOverlap.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <utility>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>
#include <opals/OverlapDef.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsOverlap_d.lib")
  #else
      #pragma comment(lib, "opalsOverlap.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleOverlap
    namespace Overlap
    {
      /// Options of \ref ModuleOverlap
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Vector<Path>  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::minArea, false, OverlapDef  >,
          ILeaf< Names::borderFile, false, Path  >,
          ILeaf< Names::overlapFile, false, Path  >,
          ILeaf< Names::pairList, true, Vector<Array<Path,2>>  >
        >;
    }
  }
 
  /// Analyses a set of strip boundaries and determines all overlapping strip pairs.
  /** TODO: 
      More details on opalsOverlap */
  /// \see \ref ModuleOverlap
  class OPALS_API IOverlap : virtual public IModuleBase
  {
 
  public:
    static IOverlap* New();
    static IOverlap* New( IControlObject &controlObject );
    static IOverlap* New( const IModuleBase &parent );
    static IOverlap* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IOverlap() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Overlap::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};