#include <CDigitalSurfaceTracker.h>

Collaboration diagram for DGtal::CDigitalSurfaceTracker< T >:

Public Types
typedef T::Self	Self
typedef T::DigitalSurfaceContainer	DigitalSurfaceContainer
typedef T::Surfel	Surfel

Public Member Functions
	BOOST_STATIC_ASSERT ((ConceptUtils::SameType< Surfel, typename DigitalSurfaceContainer::Surfel >::value))
	BOOST_CONCEPT_USAGE (CDigitalSurfaceTracker)
void	checkConstConstraints () const

Private Attributes
T	myX
DigitalSurfaceContainer	myDSC
Surfel	mySurfel
Dimension	myDim
bool	myBool
uint8_t	myInt

Detailed Description

template<typename T>
struct DGtal::CDigitalSurfaceTracker< T >

Aim:

Description of concept 'CDigitalSurfaceTracker'

Refinement of boost_concepts::CopyConstructible

Associated types :

Notation

X : A type that is a model of CDigitalSurfaceTracker
x, y : object of type X

Definitions

Valid expressions and

Name

Expression

Type requirements

Return type

Precondition

Semantics

Postcondition

Complexity

Invariants

Models

A dummy model (for concept checking) is CCDigitalSurfaceTrackerArchetype.

Notes

Template Parameters:

T	the type that should be a model of CDigitalSurfaceTracker.

Definition at line 103 of file CDigitalSurfaceTracker.h.

Member Typedef Documentation

template<typename T >

typedef T::DigitalSurfaceContainer DGtal::CDigitalSurfaceTracker< T >::DigitalSurfaceContainer

Definition at line 109 of file CDigitalSurfaceTracker.h.

template<typename T >

typedef T::Self DGtal::CDigitalSurfaceTracker< T >::Self

Definition at line 108 of file CDigitalSurfaceTracker.h.

template<typename T >

typedef T::Surfel DGtal::CDigitalSurfaceTracker< T >::Surfel

Definition at line 110 of file CDigitalSurfaceTracker.h.

Member Function Documentation

template<typename T >

DGtal::CDigitalSurfaceTracker< T >::BOOST_CONCEPT_USAGE ( CDigitalSurfaceTracker< T > )

inline

Definition at line 119 of file CDigitalSurfaceTracker.h.

References DGtal::CDigitalSurfaceTracker< T >::checkConstConstraints(), DGtal::CDigitalSurfaceTracker< T >::mySurfel, and DGtal::CDigitalSurfaceTracker< T >::myX.

    {
      // x.move( Surfel ) should exist.
      myX.move( mySurfel );
      // check const methods.
      checkConstConstraints();
    }

template<typename T >

DGtal::CDigitalSurfaceTracker< T >::BOOST_STATIC_ASSERT ( (ConceptUtils::SameType< Surfel, typename DigitalSurfaceContainer::Surfel >::value) )

template<typename T >

void DGtal::CDigitalSurfaceTracker< T >::checkConstConstraints ( ) const

inline

Definition at line 126 of file CDigitalSurfaceTracker.h.

References DGtal::CDigitalSurfaceTracker< T >::myBool, DGtal::CDigitalSurfaceTracker< T >::myDim, DGtal::CDigitalSurfaceTracker< T >::myDSC, DGtal::CDigitalSurfaceTracker< T >::myInt, DGtal::CDigitalSurfaceTracker< T >::mySurfel, DGtal::CDigitalSurfaceTracker< T >::myX, and DGtal::ConceptUtils::sameType().

Referenced by DGtal::CDigitalSurfaceTracker< T >::BOOST_CONCEPT_USAGE().

    {
      // 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 ) );
    }