DGtal::CSegmentFactory< T > Struct Template Reference

#include <CSegmentFactory.h>

Inheritance diagram for DGtal::CSegmentFactory< T >:

Collaboration diagram for DGtal::CSegmentFactory< T >:

Public Types
typedef T::Self	Self
typedef T::Reverse	Reverse
Public Types inherited from DGtal::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::CSegment< T >
	BOOST_CONCEPT_USAGE (CSegment)

Private Attributes
T	myT
Reverse	myRT

---

Detailed Description

template<typename T>
struct DGtal::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	Postcondition	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 117 of file CSegmentFactory.h.

---

Member Typedef Documentation

template<typename T >

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

Definition at line 124 of file CSegmentFactory.h.

template<typename T >

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

Definition at line 122 of file CSegmentFactory.h.

---

Member Function Documentation

template<typename T >

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

inline

Definition at line 126 of file CSegmentFactory.h.

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

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

template<typename T >

DGtal::CSegmentFactory< T >::BOOST_STATIC_ASSERT

(

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

)

---

Field Documentation

template<typename T >

Reverse DGtal::CSegmentFactory< T >::myRT

private

Definition at line 134 of file CSegmentFactory.h.

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

template<typename T >

T DGtal::CSegmentFactory< T >::myT

private

Definition at line 133 of file CSegmentFactory.h.

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

---

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

• CSegmentFactory.h