DGtal  1.0.0
Public Member Functions
DGtal::detail::IsCirculator< IC, flagHasNestedTypeCalledType > Struct Template Reference

Aim: Checks whether type IC is a circular or a classical iterator. Static value set to 'true' for a circulator, 'false' otherwise. More...

#include <DGtal/base/IteratorCirculatorTraits.h>

Public Member Functions

 BOOST_STATIC_CONSTANT (bool, value=false)
 

Detailed Description

template<typename IC, bool flagHasNestedTypeCalledType = false>
struct DGtal::detail::IsCirculator< IC, flagHasNestedTypeCalledType >

Aim: Checks whether type IC is a circular or a classical iterator. Static value set to 'true' for a circulator, 'false' otherwise.

Description of template class 'IsCirculator'

1) if type IC has no nested type 'Type', it is a classical iterator and 'false' is returned. 2) if type IC has a nested type 'Type', 'true' is returned is 'Type' is CirculatorType, 'false' otherwise.

See also
IsCirculatorFromType
Template Parameters
ICany iterator or circulator

Definition at line 127 of file IteratorCirculatorTraits.h.

Member Function Documentation

◆ BOOST_STATIC_CONSTANT()

template<typename IC , bool flagHasNestedTypeCalledType = false>
DGtal::detail::IsCirculator< IC, flagHasNestedTypeCalledType >::BOOST_STATIC_CONSTANT ( bool  ,
value  = false 
)

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