CDigitalSurfaceTracker.h

#pragma once

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

#define CDigitalSurfaceTracker_RECURSES

#if !defined CDigitalSurfaceTracker_h

#define CDigitalSurfaceTracker_h

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

namespace DGtal {
  namespace concepts {

  // class CDigitalSurfaceTracker
  template <typename T> 
  struct CDigitalSurfaceTracker : boost::CopyConstructible<T>
  {
    // ----------------------- Concept checks ------------------------------
  public:
    // 1. define first provided types (i.e. inner types), like
    typedef typename T::Self Self;
    typedef typename T::DigitalSurfaceContainer DigitalSurfaceContainer;
    typedef typename T::Surfel Surfel;
    // possibly check these types so as to satisfy a concept with
    // BOOST_CONCEPT_ASSERT
    // (( CDigitalSurfaceContainer< DigitalSurfaceContainer > ));
    // To test if two types A and Y are equals, use
    BOOST_STATIC_ASSERT
    ( (ConceptUtils::SameType< Surfel,
       typename DigitalSurfaceContainer::Surfel >::value) );    
    // 2. then check the presence of data members, operators and methods with
    BOOST_CONCEPT_USAGE( CDigitalSurfaceTracker )
    {
      // x.move( Surfel ) should exist.
      myX.move( mySurfel );
      // check const methods.
      checkConstConstraints();
    }
    void checkConstConstraints() const
    {
      // x.surface() const, returns a const DigitalSurfaceContainer &
      ConceptUtils::sameType( myDSC, myX.surface() );
      // x.current() const, returns a Surfel
      ConceptUtils::sameType( mySurfel, myX.current() );
      // x.orthDir() const, returns a Dimension
      ConceptUtils::sameType( myDim, myX.orthDir() );
      // x.adjacent( Surfel&, Dimension, bool ) const, returns a uint8_t
      Surfel modifiableSurfel;
      ConceptUtils::sameType( myInt, 
                              myX.adjacent( modifiableSurfel, myDim, myBool ) );
    }

    // ------------------------- Private Datas --------------------------------
  private:
    T myX; // only if T is default constructible.
    DigitalSurfaceContainer myDSC;
    Surfel mySurfel;
    Dimension myDim;
    bool myBool;
    uint8_t myInt;
    
    // ------------------------- Internals ------------------------------------
  private:
    
  }; // end of concept CDigitalSurfaceTracker
  
} // namespace concepts
} // namespace DGtal

//                                                                           //

#endif // !defined CDigitalSurfaceTracker_h

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