DGtal::concepts::CSegmentFactory< T > Struct Template Reference

Aim: Defines the concept describing a segment ie. a valid and not empty subrange, which can construct instances of its own type or of derived type. More...

#include <DGtal/geometry/curves/CSegmentFactory.h>

Inheritance diagram for DGtal::concepts::CSegmentFactory< T >:

Public Types
typedef T::Self	Self
typedef T::Reverse	Reverse
Public Types inherited from DGtal::concepts::CSegment< T >
typedef T::ConstIterator	ConstIterator

Public Member Functions
	BOOST_STATIC_ASSERT ((boost::is_same< T, Self >::value))
	BOOST_CONCEPT_USAGE (CSegmentFactory)
Public Member Functions inherited from DGtal::concepts::CSegment< T >
	BOOST_CONCEPT_USAGE (CSegment)

Private Attributes
T	myT
Reverse	myRT

Detailed Description

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

Aim: Defines the concept describing a segment ie. a valid and not empty subrange, which can construct instances of its own type or of derived type.

Description of concept 'CSegmentFactory'

Refinement of CSegment

Associated types

• Self, its own type
• Reverse, same as Self but using std::reverse_iterator<Self::ConstIterator> instead of Self::ConstIterator as the underlying iterator

Notation

• X : A type that is a model of CSegmentFactory
• x : object of type X

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
getSelf method	x.getSelf()		X::Self		returns an instance of Self, which is constructed from the same input parameters used to construct x (if any)		depends on the internal structures defined in x
conversion	x.getReverse()		X::Reverse		returns an instance of Reverse, which is constructed from the same input parameters used to construct x (if any)		depends on the internal structures defined in x

Invariants

Models

Notes

Template Parameters

T	the type that should be a model of CSegmentFactory.

Definition at line 92 of file CSegmentFactory.h.

Member Typedef Documentation

Reverse

template<typename T >

typedef T::Reverse DGtal::concepts::CSegmentFactory< T >::Reverse

Definition at line 99 of file CSegmentFactory.h.

Self

template<typename T >

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

Definition at line 97 of file CSegmentFactory.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 101 of file CSegmentFactory.h.

      {
        concepts::ConceptUtils::sameType( myT, myT.getSelf() );
        concepts::ConceptUtils::sameType( myRT, myT.getReverse() );
      }

References DGtal::concepts::CSegmentFactory< T >::myRT, DGtal::concepts::CSegmentFactory< T >::myT, and DGtal::concepts::ConceptUtils::sameType().

BOOST_STATIC_ASSERT()

template<typename T >

DGtal::concepts::CSegmentFactory< T >::BOOST_STATIC_ASSERT

(

(boost::is_same< T, Self >::value)

)

Field Documentation

myRT

template<typename T >

Reverse DGtal::concepts::CSegmentFactory< T >::myRT

private

Definition at line 109 of file CSegmentFactory.h.

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

myT

template<typename T >

T DGtal::concepts::CSegmentFactory< T >::myT

private

Definition at line 108 of file CSegmentFactory.h.

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

---

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

• CSegmentFactory.h