DGtal  1.3.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CDigitalSurfaceTracker< T > Struct Template Reference

Aim: More...

#include <DGtal/topology/CDigitalSurfaceTracker.h>

Inheritance diagram for DGtal::concepts::CDigitalSurfaceTracker< T >:
[legend]

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

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

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
Tthe 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.

102  {
103  // x.move( Surfel ) should exist.
104  myX.move( mySurfel );
105  // check const methods.
107  }

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.

109  {
110  // x.surface() const, returns a const DigitalSurfaceContainer &
111  ConceptUtils::sameType( myDSC, myX.surface() );
112  // x.current() const, returns a Surfel
113  ConceptUtils::sameType( mySurfel, myX.current() );
114  // x.orthDir() const, returns a Dimension
115  ConceptUtils::sameType( myDim, myX.orthDir() );
116  // x.adjacent( Surfel&, Dimension, bool ) const, returns a uint8_t
117  Surfel modifiableSurfel;
119  myX.adjacent( modifiableSurfel, myDim, myBool ) );
120  }

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

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

Field Documentation

◆ myBool

template<typename T >
bool DGtal::concepts::CDigitalSurfaceTracker< T >::myBool
private

◆ myDim

template<typename T >
Dimension DGtal::concepts::CDigitalSurfaceTracker< T >::myDim
private

◆ myDSC

template<typename T >
DigitalSurfaceContainer DGtal::concepts::CDigitalSurfaceTracker< T >::myDSC
private

◆ myInt

template<typename T >
uint8_t DGtal::concepts::CDigitalSurfaceTracker< T >::myInt
private

◆ mySurfel

template<typename T >
Surfel DGtal::concepts::CDigitalSurfaceTracker< T >::mySurfel
private

◆ myX

template<typename T >
T DGtal::concepts::CDigitalSurfaceTracker< T >::myX
private

The documentation for this struct was generated from the following file:
DGtal::concepts::CDigitalSurfaceTracker::myDim
Dimension myDim
Definition: CDigitalSurfaceTracker.h:127
DGtal::concepts::CDigitalSurfaceTracker::myDSC
DigitalSurfaceContainer myDSC
Definition: CDigitalSurfaceTracker.h:125
DGtal::SignedKhalimskyCell
Represents a signed cell in a cellular grid space by its Khalimsky coordinates and a boolean value.
Definition: KhalimskySpaceND.h:208
DGtal::concepts::CDigitalSurfaceTracker::myX
T myX
Definition: CDigitalSurfaceTracker.h:124
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CDigitalSurfaceTracker::myInt
uint8_t myInt
Definition: CDigitalSurfaceTracker.h:129
DGtal::concepts::CDigitalSurfaceTracker::myBool
bool myBool
Definition: CDigitalSurfaceTracker.h:128
DGtal::concepts::CDigitalSurfaceTracker::checkConstConstraints
void checkConstConstraints() const
Definition: CDigitalSurfaceTracker.h:108
DGtal::concepts::CDigitalSurfaceTracker::mySurfel
Surfel mySurfel
Definition: CDigitalSurfaceTracker.h:126