DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage > Class Template Reference

Aim: model of CConstBidirectionalRangeFromPoint that adapts a TiledImage range of elements bounded by two iterators [itb, ite) and provides services to (circularly)iterate over it (in a read-only manner). More...

#include <DGtal/base/TiledImageBidirectionalConstRangeFromPoint.h>

Inheritance diagram for DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >:

Public Types
typedef TTiledImage	TiledImage
typedef TiledImage::Point	Point
typedef TiledImage::ConstIterator	ConstIterator
typedef boost::reverse_iterator< ConstIterator >	ConstReverseIterator
typedef Circulator< ConstIterator >	ConstCirculator
typedef boost::reverse_iterator< ConstCirculator >	ConstReverseCirculator

Public Member Functions
	TiledImageBidirectionalConstRangeFromPoint (const TiledImage *ti)
	TiledImageBidirectionalConstRangeFromPoint (const TiledImageBidirectionalConstRangeFromPoint &other)
TiledImageBidirectionalConstRangeFromPoint &	operator= (const TiledImageBidirectionalConstRangeFromPoint &other)
	~TiledImageBidirectionalConstRangeFromPoint ()
bool	isValid () const
void	selfDisplay (std::ostream &out) const
std::string	className () const
ConstIterator	begin () const
ConstIterator	begin (const Point &aPoint) const
ConstIterator	end () const
ConstReverseIterator	rbegin () const
ConstReverseIterator	rbegin (const Point &aPoint) const
ConstReverseIterator	rend () const
ConstCirculator	c () const
ConstReverseCirculator	rc () const

Private Member Functions
	BOOST_CONCEPT_ASSERT ((boost::BidirectionalIterator< typename TTiledImage::ConstIterator >))

Private Attributes
const TTiledImage *	myti

Detailed Description

template<typename TTiledImage>
class DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >

Aim: model of CConstBidirectionalRangeFromPoint that adapts a TiledImage range of elements bounded by two iterators [itb, ite) and provides services to (circularly)iterate over it (in a read-only manner).

Template Parameters

TTiledImage

the type of the TiledImage with his const iterator to adapt (at least bidirectional)

See also

ConstRangeAdapter

Definition at line 72 of file TiledImageBidirectionalConstRangeFromPoint.h.

Member Typedef Documentation

ConstCirculator

template<typename TTiledImage>

typedef Circulator<ConstIterator> DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::ConstCirculator

Definition at line 88 of file TiledImageBidirectionalConstRangeFromPoint.h.

ConstIterator

template<typename TTiledImage>

typedef TiledImage::ConstIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::ConstIterator

Definition at line 85 of file TiledImageBidirectionalConstRangeFromPoint.h.

ConstReverseCirculator

template<typename TTiledImage>

typedef boost::reverse_iterator<ConstCirculator> DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::ConstReverseCirculator

Definition at line 89 of file TiledImageBidirectionalConstRangeFromPoint.h.

ConstReverseIterator

template<typename TTiledImage>

typedef boost::reverse_iterator<ConstIterator> DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::ConstReverseIterator

Definition at line 86 of file TiledImageBidirectionalConstRangeFromPoint.h.

Point

template<typename TTiledImage>

typedef TiledImage::Point DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::Point

Definition at line 83 of file TiledImageBidirectionalConstRangeFromPoint.h.

TiledImage

template<typename TTiledImage>

typedef TTiledImage DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::TiledImage

Definition at line 81 of file TiledImageBidirectionalConstRangeFromPoint.h.

Constructor & Destructor Documentation

TiledImageBidirectionalConstRangeFromPoint() [1/2]

template<typename TTiledImage>

DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::TiledImageBidirectionalConstRangeFromPoint ( const TiledImage * ti )

inline

Standard constructor from a TiledImage.

Parameters

ti	pointer on a TiledImage.

Definition at line 97 of file TiledImageBidirectionalConstRangeFromPoint.h.

        : myti ( ti ) {}

TiledImageBidirectionalConstRangeFromPoint() [2/2]

template<typename TTiledImage>

DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::TiledImageBidirectionalConstRangeFromPoint ( const TiledImageBidirectionalConstRangeFromPoint< TTiledImage > & other )

inline

Copy constructor.

Parameters

other

the iterator to clone.

Definition at line 104 of file TiledImageBidirectionalConstRangeFromPoint.h.

          : myti ( other.myti ) {}

~TiledImageBidirectionalConstRangeFromPoint()

template<typename TTiledImage>

DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::~TiledImageBidirectionalConstRangeFromPoint ( )

inline

Destructor. Does nothing.

Definition at line 125 of file TiledImageBidirectionalConstRangeFromPoint.h.

{}

Member Function Documentation

begin() [1/2]

template<typename TTiledImage>

ConstIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::begin ( ) const

inline

Iterator service.

Returns

begin iterator

Definition at line 173 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstIterator ( myti->begin() );
      }

Referenced by DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::c(), and DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::rend().

begin() [2/2]

template<typename TTiledImage>

ConstIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::begin ( const Point & aPoint ) const

inline

Iterator service.

Returns

begin iterator

Definition at line 182 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstIterator ( myti->begin(aPoint) );
      }

BOOST_CONCEPT_ASSERT()

template<typename TTiledImage>

DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::BOOST_CONCEPT_ASSERT ( (boost::BidirectionalIterator< typename TTiledImage::ConstIterator >) )

private

c()

template<typename TTiledImage>

ConstCirculator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::c ( ) const

inline

Circulator service.

Returns

a circulator

Definition at line 227 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstCirculator ( this->begin(), this->begin(), this->end() );
      }

Referenced by DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::rc().

className()

template<typename TTiledImage>

std::string DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::className ( ) const

inline

Returns

the style name used for drawing this object.

Definition at line 153 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return "TiledImageBidirectionalConstRangeFromPoint";
      }

end()

template<typename TTiledImage>

ConstIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::end ( ) const

inline

Iterator service.

Returns

end iterator

Definition at line 191 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstIterator ( myti->end() );
      }

Referenced by DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::c(), and DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::rbegin().

isValid()

template<typename TTiledImage>

bool DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns

'true' if the object is valid, 'false' otherwise.

Definition at line 131 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return true;
      }

operator=()

template<typename TTiledImage>

TiledImageBidirectionalConstRangeFromPoint & DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::operator= ( const TiledImageBidirectionalConstRangeFromPoint< TTiledImage > & other )

inline

Assignment.

Parameters

other

the iterator to copy.

Returns

a reference on 'this'.

Definition at line 112 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        if ( this != &other )
        {
          myti = other.myti;
        }
 
        return *this;
      }

rbegin() [1/2]

template<typename TTiledImage>

ConstReverseIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::rbegin ( ) const

inline

Iterator service.

Returns

rbegin iterator

Definition at line 200 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstReverseIterator ( this->end() );
      }

rbegin() [2/2]

template<typename TTiledImage>

ConstReverseIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::rbegin ( const Point & aPoint ) const

inline

Iterator service.

Returns

rbegin iterator

Definition at line 209 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstReverseIterator ( myti->rbegin(aPoint) );
      }

rc()

template<typename TTiledImage>

ConstReverseCirculator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::rc ( ) const

inline

Circulator service.

Returns

a reverse circulator

Definition at line 236 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstReverseCirculator ( this->c() );
      }

rend()

template<typename TTiledImage>

ConstReverseIterator DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::rend ( ) const

inline

Iterator service.

Returns

rend iterator

Definition at line 218 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        return ConstReverseIterator ( this->begin() );
      }

selfDisplay()

template<typename TTiledImage>

void DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::selfDisplay ( std::ostream & out ) const

inline

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

Definition at line 141 of file TiledImageBidirectionalConstRangeFromPoint.h.

      {
        typedef typename IteratorCirculatorTraits<ConstIterator>::Value Value;
        out << "[TiledImageBidirectionalConstRangeFromPoint]" << std::endl;
        out << "\t";
        std::copy ( myti->begin(), myti->end(), std::ostream_iterator<Value> ( out, ", " ) );
        out << std::endl;
      }

Field Documentation

myti

template<typename TTiledImage>

const TTiledImage* DGtal::TiledImageBidirectionalConstRangeFromPoint< TTiledImage >::myti

private

Definition at line 163 of file TiledImageBidirectionalConstRangeFromPoint.h.

Referenced by DGtal::TiledImageBidirectionalConstRangeFromPoint< TiledImage >::operator=().

---

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

• TiledImageBidirectionalConstRangeFromPoint.h