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

Aim: Defines the concept describing a dynamic segment computer,
ie. a model of CSegment that can extend and retract itself (in the direction that is relative to the underlying iterator).
More...

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

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

Public Member Functions
	BOOST_CONCEPT_USAGE (CDynamicSegmentComputer)
Public Member Functions inherited from DGtal::concepts::CIncrementalSegmentComputer< T >
	BOOST_CONCEPT_USAGE (CIncrementalSegmentComputer)
Public Member Functions inherited from DGtal::concepts::CSegmentFactory< T >
	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	myX
bool	myB

Additional Inherited Members
Public Types inherited from DGtal::concepts::CSegmentFactory< T >
typedef T::Self	Self
typedef T::Reverse	Reverse
Public Types inherited from DGtal::concepts::CSegment< T >
typedef T::ConstIterator	ConstIterator

Detailed Description

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

Aim: Defines the concept describing a dynamic segment computer,
ie. a model of CSegment that can extend and retract itself (in the direction that is relative to the underlying iterator).

Description of concept 'CDynamicSegmentComputer'

Refinement of CForwardSegmentComputer

Associated types the same as CForwardSegmentComputer

Notation

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

Definitions

Valid expressions and

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Retraction	x.retractBack()		bool		returns 'tru' if ++x.begin() != x.end() (and increments the begin iterator), 'false' otherwise

Invariants

Models

Notes

Template Parameters

T	the type that should be a model of CDynamicSegmentComputer.

Definition at line 88 of file CDynamicSegmentComputer.h.

Member Function Documentation

BOOST_CONCEPT_USAGE()

template<typename T >

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

inline

Definition at line 93 of file CDynamicSegmentComputer.h.

    {
      concepts::ConceptUtils::sameType( myB, myX.retractBack() );
    }

References DGtal::concepts::CDynamicSegmentComputer< T >::myB, DGtal::concepts::CDynamicSegmentComputer< T >::myX, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myB

template<typename T >

bool DGtal::concepts::CDynamicSegmentComputer< T >::myB

private

Definition at line 100 of file CDynamicSegmentComputer.h.

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

myX

template<typename T >

T DGtal::concepts::CDynamicSegmentComputer< T >::myX

private

Definition at line 99 of file CDynamicSegmentComputer.h.

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

---

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

• CDynamicSegmentComputer.h