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

Aim: refined concept of const single pass range with a begin() method from a point. More...

#include <DGtal/base/CConstSinglePassRangeFromPoint.h>

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

Public Types

typedef T::Point Point
 
- Public Types inherited from DGtal::concepts::CConstSinglePassRange< T >
typedef T::ConstIterator ConstIterator
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CConstSinglePassRangeFromPoint)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CConstSinglePassRange< T >
 BOOST_CONCEPT_ASSERT ((boost_concepts::SinglePassIteratorConcept< ConstIterator >))
 
 BOOST_CONCEPT_USAGE (CConstSinglePassRange)
 
void checkConstConstraints () const
 

Private Attributes

myX
 
Point myPoint
 
ConstIterartor myB
 

Detailed Description

template<typename T>
struct DGtal::concepts::CConstSinglePassRangeFromPoint< T >

Aim: refined concept of const single pass range with a begin() method from a point.

Description of concept 'CConstSinglePassRangeFromPoint'

Refinement of CConstSinglePassRange

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
begin begin(const Point &aPoint) aPoint of type Point ConstIterator Returns a const iterator on the range first element

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CConstSinglePassRangeFromPoint.

Definition at line 86 of file CConstSinglePassRangeFromPoint.h.

Member Typedef Documentation

◆ Point

template<typename T >
typedef T::Point DGtal::concepts::CConstSinglePassRangeFromPoint< T >::Point

Definition at line 91 of file CConstSinglePassRangeFromPoint.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CConstSinglePassRangeFromPoint< T >::BOOST_CONCEPT_USAGE ( CConstSinglePassRangeFromPoint< T >  )
inline

Definition at line 94 of file CConstSinglePassRangeFromPoint.h.

95  {
97  }

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CConstSinglePassRangeFromPoint< T >::checkConstConstraints ( ) const
inline

Definition at line 98 of file CConstSinglePassRangeFromPoint.h.

99  {
100  // const method dummyConst should take parameter myA of type A and return
101  // something of type B
102  ConceptUtils::sameType( myB, myX.begin( myPoint ) );
103  }

Referenced by DGtal::concepts::CConstSinglePassRangeFromPoint< T, Value >::BOOST_CONCEPT_USAGE().

Field Documentation

◆ myB

template<typename T >
ConstIterartor DGtal::concepts::CConstSinglePassRangeFromPoint< T >::myB
private

◆ myPoint

template<typename T >
Point DGtal::concepts::CConstSinglePassRangeFromPoint< T >::myPoint
private

◆ myX

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

The documentation for this struct was generated from the following file:
DGtal::concepts::CConstSinglePassRangeFromPoint::checkConstConstraints
void checkConstConstraints() const
Definition: CConstSinglePassRangeFromPoint.h:98
DGtal::concepts::CConstSinglePassRangeFromPoint::myX
T myX
Definition: CConstSinglePassRangeFromPoint.h:106
DGtal::concepts::CConstSinglePassRangeFromPoint::myPoint
Point myPoint
Definition: CConstSinglePassRangeFromPoint.h:107
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CConstSinglePassRangeFromPoint::myB
ConstIterartor myB
Definition: CConstSinglePassRangeFromPoint.h:108