ILineTopology.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/TopologyProcessingMethod.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
    #pragma comment(lib, "opalsLineTopology_d.lib")
  #else
    #pragma comment(lib, "opalsLineTopology.lib")
  #endif
#endif
 
namespace opals
{
 
  namespace opts
  {
    /// Options of \ref ModuleLineTopology
    namespace LineTopology
    {
      /// Options of \ref ModuleLineTopology
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::outFile, false, Path  >,
          IValue< Names::method, false, TopologyProcessingMethod  >,
          IValue< Names::minLength, false, double  >,
          IValue< Names::maxTol, false, double  >,
          IValue< Names::lineVertexDist, false, double  >,
          IValue< Names::snapRadius, false, double  >,
          IValue< Names::maxAngleDev, false, Vector< float >  >,
          IValue< Names::avgDist, false, double  >,
          IValue< Names::debugOutFile, false, Path  >,
          IGroup< Names::merge,
            IValue< Names::minWeight, false, double  >,
            IValue< Names::relWeightLead, false, double  >,
            IValue< Names::maxIter, false, unsigned  >,
            IValue< Names::revertDist, false, double  >,
            IValue< Names::revertInterval, false, double  >,
            IValue< Names::searchGeneration, false, unsigned  >,
            IValue< Names::preventIntersection, false, bool  >
          >,
          IGroup< Names::wf,
            IValue< Names::dist, false, double  >,
            IValue< Names::angle, false, Vector< float >  >,
            IValue< Names::revertDist, false, double  >,
            IValue< Names::straightness, false, double  >,
            IValue< Names::perpDist, false, double  >
          >,
          IGroup< Names::clean,
            IValue< Names::intersectSnapDist, false, double  >
          >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::LineTopology::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
}