ILineTopology.hpp

#ifndef OPALS_ILINETOPOLOGY_HPP_INCLUDED
#define OPALS_ILINETOPOLOGY_HPP_INCLUDED

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

#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/TopologyProcessingMethod.hpp>

namespace opals
{

  namespace opts
  {
    namespace LineTopology
    {
      /// Options of \ref ModuleLineTopology
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::method, false, opals::TopologyProcessingMethod::Type >, Cons<
        ILeaf< Names::minLength, false, double >, Cons<
        ILeaf< Names::maxTol, false, double >, Cons<
        ILeaf< Names::lineVertexDist, false, double >, Cons<
        ILeaf< Names::snapRadius, false, double >, Cons<
        ILeaf< Names::maxAngleDev, false, opals::Vector< float > >, Cons<
        ILeaf< Names::avgDist, false, double >, Cons<
        ILeaf< Names::debugOutFile, false, opals::Path >, Cons<
        IGroup< Names::merge, false,  Cons<
          ILeaf< Names::minWeight, false, double >, Cons<
          ILeaf< Names::relWeightLead, false, double >, Cons<
          ILeaf< Names::maxIter, false, unsigned >, Cons<
          ILeaf< Names::revertDist, false, double >, Cons<
          ILeaf< Names::revertInterval, false, double >, Cons<
          ILeaf< Names::searchGeneration, false, unsigned >, Cons<
          ILeaf< Names::preventIntersection, false, bool >
        > > > > > > > >, Cons<
        IGroup< Names::wf, false,  Cons<
          ILeaf< Names::dist, false, double >, Cons<
          ILeaf< Names::angle, false, opals::Vector< float > >, Cons<
          ILeaf< Names::revertDist, false, double >, Cons<
          ILeaf< Names::straightness, false, double >, Cons<
          ILeaf< Names::perpDist, false, double >
        > > > > > >, Cons<
        IGroup< Names::clean, false,  Cons<
          ILeaf< Names::intersectSnapDist, false, double >
        > >
      > > > > > > > > > > > > > > Options;
    }
  }

  /// Provides different line merging and topology correction tools for cleaning line networks derived via automatic edge detection.
  /** TODO: 
      More details on opalsLineTopology with much more words,
      possibly on several lines. */
  /// \see \ref ModuleLineTopology
  class OPALS_API ILineTopology : virtual public IModuleBase
  {

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

    virtual ~ILineTopology() {}

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

  };

}

#endif