DigitalSurface2DSlice.h

#pragma once

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

#define DigitalSurface2DSlice_RECURSES

#if !defined DigitalSurface2DSlice_h

#define DigitalSurface2DSlice_h

// Inclusions
#include <iostream>
#include <deque>
#include "DGtal/base/Common.h"
#include "DGtal/base/Circulator.h"
#include "DGtal/topology/CDigitalSurfaceTracker.h"

namespace DGtal
{

  // template class DigitalSurface2DSlice
  template <typename TDigitalSurfaceTracker>
  class DigitalSurface2DSlice
  {
  public:
    typedef TDigitalSurfaceTracker DigitalSurfaceTracker;
    BOOST_CONCEPT_ASSERT(( CDigitalSurfaceTracker<DigitalSurfaceTracker> ));

    typedef DigitalSurface2DSlice<DigitalSurfaceTracker> Self;
    typedef typename DigitalSurfaceTracker::DigitalSurfaceContainer DigitalSurfaceContainer;
    typedef typename DigitalSurfaceContainer::KSpace KSpace;
    typedef typename DigitalSurfaceContainer::Surfel Surfel;
    typedef typename DigitalSurfaceContainer::Size Size;
    typedef DigitalSurface<DigitalSurfaceContainer> TheDigitalSurface;

    typedef std::deque<Surfel> Storage;
    typedef typename Storage::const_iterator ConstIterator;
    typedef typename Storage::const_reverse_iterator ConstReverseIterator;
    typedef Circulator<ConstIterator> ConstCirculator;
    typedef Circulator<ConstReverseIterator> ConstReverseCirculator;


    // ----------------------- Standard services ------------------------------
  public:

    ~DigitalSurface2DSlice();

    DigitalSurface2DSlice( DigitalSurfaceTracker* tracker, Dimension i );

    bool init( DigitalSurfaceTracker* tracker, Dimension i );

    Size size() const;

    bool isClosed() const;

    ConstIterator start() const;

    ConstReverseIterator rstart() const;

    ConstCirculator cstart() const;

    ConstReverseCirculator rcstart() const;

    // ------------------------- iterator services ----------------------------
  public:
    
    ConstIterator begin() const;
    
    ConstIterator end() const;
    
    ConstReverseIterator rbegin() const;
    
    ConstReverseIterator rend() const;
    
    ConstCirculator c() const;
    
    ConstReverseCirculator rc() const;
    
    // ----------------------- Interface --------------------------------------
  public:

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    std::deque<Surfel> mySurfels;
    bool myIsClosed;
    ConstIterator myStart;
    // ------------------------- Hidden services ------------------------------
  protected:

    DigitalSurface2DSlice();

  private:

    DigitalSurface2DSlice ( const DigitalSurface2DSlice & other );

    DigitalSurface2DSlice & operator= ( const DigitalSurface2DSlice & other );

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

  }; // end of class DigitalSurface2DSlice


  template <typename TDigitalSurfaceTracker>
  std::ostream&
  operator<< ( std::ostream & out, const DigitalSurface2DSlice<TDigitalSurfaceTracker> & object );

} // namespace DGtal


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

//                                                                           //

#endif // !defined DigitalSurface2DSlice_h

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