#include <DGtal/topology/CDigitalSurfaceTracker.h>

Inheritance diagram for DGtal::concepts::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::concepts::CDigitalSurfaceTracker< T >

Aim:

Description of concept 'CDigitalSurfaceTracker'

Todo:: Complete documentation

Refinement of

boost::CopyConstructible

Associated types

Notation

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

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	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 85 of file CDigitalSurfaceTracker.h.

Member Typedef Documentation

◆ DigitalSurfaceContainer

template<typename T >

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

Definition at line 91 of file CDigitalSurfaceTracker.h.

◆ Self

template<typename T >

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

Definition at line 90 of file CDigitalSurfaceTracker.h.

◆ Surfel

template<typename T >

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

Definition at line 92 of file CDigitalSurfaceTracker.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 101 of file CDigitalSurfaceTracker.h.

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

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

◆ BOOST_STATIC_ASSERT()

template<typename T >

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

◆ checkConstConstraints()

template<typename T >

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

inline

Definition at line 108 of file CDigitalSurfaceTracker.h.

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