Loading [MathJax]/extensions/TeX/AMSsymbols.js
DGtal 2.0.0
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'

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 checkConstConstraints(), mySurfel, and 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
119 myX.adjacent( modifiableSurfel, myDim, myBool ) );
120 }
void sameType(const T &, const T &)

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

Referenced by BOOST_CONCEPT_USAGE().

Field Documentation

◆ myBool

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

Definition at line 128 of file CDigitalSurfaceTracker.h.

Referenced by checkConstConstraints().

◆ myDim

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

Definition at line 127 of file CDigitalSurfaceTracker.h.

Referenced by checkConstConstraints().

◆ myDSC

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

Definition at line 125 of file CDigitalSurfaceTracker.h.

Referenced by checkConstConstraints().

◆ myInt

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

Definition at line 129 of file CDigitalSurfaceTracker.h.

Referenced by checkConstConstraints().

◆ mySurfel

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

Definition at line 126 of file CDigitalSurfaceTracker.h.

Referenced by BOOST_CONCEPT_USAGE(), and checkConstConstraints().

◆ myX

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

Definition at line 124 of file CDigitalSurfaceTracker.h.

Referenced by BOOST_CONCEPT_USAGE(), and checkConstConstraints().


The documentation for this struct was generated from the following file: