DigitalTopology.h

#pragma once

#if defined(DigitalTopology_RECURSES)
#error Recursive header files inclusion detected in DigitalTopology.h
#else // defined(DigitalTopology_RECURSES)

#define DigitalTopology_RECURSES

#if !defined DigitalTopology_h

#define DigitalTopology_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/topology/CAdjacency.h"

namespace DGtal
{

  enum DigitalTopologyProperties { UNKNOWN_DT = 0, 
           NOT_JORDAN_DT = 1,
           JORDAN_DT = 2 };

  // template class DigitalTopology
  template <typename TForegroundAdjacency, typename TBackgroundAdjacency>
  class DigitalTopology
  {
    // ----------------------- Standard services ------------------------------
  public:
    typedef TForegroundAdjacency ForegroundAdjacency;
    typedef TBackgroundAdjacency BackgroundAdjacency;
    typedef typename ForegroundAdjacency::Point Point;
    // should be the same as Point.
    typedef typename BackgroundAdjacency::Point BackPoint; 
    
    BOOST_CONCEPT_ASSERT(( concepts::CAdjacency< ForegroundAdjacency > ));
    BOOST_CONCEPT_ASSERT(( concepts::CAdjacency< BackgroundAdjacency > ));
    
    typedef DigitalTopology<BackgroundAdjacency,ForegroundAdjacency> 
    ReverseTopology;


    DigitalTopology( ConstAlias<ForegroundAdjacency> aKappa, 
         ConstAlias<BackgroundAdjacency> aLambda,
         DigitalTopologyProperties props = UNKNOWN_DT );

    ~DigitalTopology();

    DigitalTopology ( const DigitalTopology & other );


    const ForegroundAdjacency & kappa() const;

    const BackgroundAdjacency & lambda() const;

    DigitalTopologyProperties properties() const;

    ReverseTopology reverseTopology() const;

    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    const ForegroundAdjacency & myKappa;

    const BackgroundAdjacency & myLambda;

    const DigitalTopologyProperties myProps;

    // ------------------------- Hidden services ------------------------------
  protected:

    DigitalTopology();

  private:

    DigitalTopology & operator= ( const DigitalTopology & other );

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class DigitalTopology


  template <typename TForegroundAdjacency, typename TBackgroundAdjacency>
  std::ostream&
  operator<< ( std::ostream & out, 
         const DigitalTopology<TForegroundAdjacency,TBackgroundAdjacency> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/topology/DigitalTopology.ih"

//                                                                           //

#endif // !defined DigitalTopology_h

#undef DigitalTopology_RECURSES
#endif // else defined(DigitalTopology_RECURSES)