IOverlap.hpp

#ifndef OPALS_IOVERLAP_HPP_INCLUDED
#define OPALS_IOVERLAP_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <utility>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>
#include <opals/OverlapDef.hpp>

typedef opals::Array<opals::Path,2> StripPair;

namespace opals {

  namespace opts
  {
    namespace Overlap
    {
      /// Options of \ref ModuleOverlap
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::minArea, false, opals::OverlapDef >, Cons<
        ILeaf< Names::borderFile, false, opals::Path >, Cons<
        ILeaf< Names::overlapFile, false, opals::Path >, Cons<
        ILeaf< Names::pairList, true, opals::Vector<StripPair> >
      > > > > > > > Options;
    }
  }

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

  };

};

#endif