duds::ui::graphics::BppImageArchiveSequence::iterator Class Reference

An input iterator that will parse and supply image data from the stream. More...

#include <BppImageArchiveSequence.hpp>

Collaboration diagram for duds::ui::graphics::BppImageArchiveSequence::iterator:

Public Member Functions
	iterator (BppImageArchiveSequence *parent)
	Makes a new iterator, but does not prepare the BppImageArchiveSequence object to use the iterator, and results in an iterator that is invalid. More...
constexpr	iterator ()
	Equivalent to the end iterator. More...
const BppImageSptr &	image () const
	Returns the image. More...
const std::string &	name () const
	Returns the name of the image. More...
bool	operator!= (const iterator &i) const
	Inequality operator. More...
const std::pair< std::string, BppImageSptr > &	operator* () const
	Provides a std::pair with the name of the image and the image itself. More...
iterator &	operator++ ()
	Pre-increment operator; parses the next image. More...
iterator	operator++ (int)
	Post-increment operator; involves making a copy of this iterator. More...
const std::pair< std::string, BppImageSptr > *	operator-> () const
	Provides a pointer to a std::pair with the name of the image and the image itself. More...
bool	operator== (const iterator &i) const
	Equality operator. More...

Private Attributes
BppImageArchiveSequence *	bias
	The object containing the data required for this iterator to work. More...

Detailed Description

An input iterator that will parse and supply image data from the stream.

When incremented, any copies of the iterator must be considered invalid. The default constructed iterator is always equivalent to the end iterator, and is a constexpr object.

Author

Jeff Jackowski

Definition at line 54 of file BppImageArchiveSequence.hpp.

Constructor & Destructor Documentation

iterator() [1/2]

duds::ui::graphics::BppImageArchiveSequence::iterator::iterator ( BppImageArchiveSequence *  parent )

inline

Makes a new iterator, but does not prepare the BppImageArchiveSequence object to use the iterator, and results in an iterator that is invalid.

BppImageArchiveSequence::begin() implements the remaining steps to make the iterator valid.

Definition at line 66 of file BppImageArchiveSequence.hpp.

iterator() [2/2]

constexpr duds::ui::graphics::BppImageArchiveSequence::iterator::iterator ( )

inline

Equivalent to the end iterator.

Definition at line 70 of file BppImageArchiveSequence.hpp.

Referenced by duds::ui::graphics::BppImageArchiveSequence::end().

Member Function Documentation

image()

const BppImageSptr& duds::ui::graphics::BppImageArchiveSequence::iterator::image ( ) const

inline

Returns the image.

Definition at line 121 of file BppImageArchiveSequence.hpp.

name()

const std::string& duds::ui::graphics::BppImageArchiveSequence::iterator::name ( ) const

inline

Returns the name of the image.

Definition at line 115 of file BppImageArchiveSequence.hpp.

operator!=()

bool duds::ui::graphics::BppImageArchiveSequence::iterator::operator!= ( const iterator &  i ) const

inline

Inequality operator.

Definition at line 80 of file BppImageArchiveSequence.hpp.

operator*()

const std::pair<std::string, BppImageSptr>& duds::ui::graphics::BppImageArchiveSequence::iterator::operator* ( ) const

inline

Provides a std::pair with the name of the image and the image itself.

Definition at line 102 of file BppImageArchiveSequence.hpp.

operator++() [1/2]

BppImageArchiveSequence::iterator & duds::ui::graphics::BppImageArchiveSequence::iterator::operator++

(

)

Pre-increment operator; parses the next image.

Exceptions

ImageArchivePastEndError	The incremented iterator is the end iterator.
ImageArchiveStreamTruncatedError	The next image has incomplete data.

Definition at line 22 of file BppImageArchiveSequence.cpp.

Referenced by operator!=(), and operator++().

operator++() [2/2]

iterator duds::ui::graphics::BppImageArchiveSequence::iterator::operator++ ( int  )

inline

Post-increment operator; involves making a copy of this iterator.

Definition at line 94 of file BppImageArchiveSequence.hpp.

operator->()

const std::pair<std::string, BppImageSptr>* duds::ui::graphics::BppImageArchiveSequence::iterator::operator-> ( ) const

inline

Provides a pointer to a std::pair with the name of the image and the image itself.

Definition at line 109 of file BppImageArchiveSequence.hpp.

operator==()

bool duds::ui::graphics::BppImageArchiveSequence::iterator::operator== ( const iterator &  i ) const

inline

Equality operator.

Definition at line 74 of file BppImageArchiveSequence.hpp.

Member Data Documentation

bias

BppImageArchiveSequence* duds::ui::graphics::BppImageArchiveSequence::iterator::bias

private

The object containing the data required for this iterator to work.

Definition at line 58 of file BppImageArchiveSequence.hpp.

Referenced by operator!=(), and operator==().

---

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

• BppImageArchiveSequence.hpp
• BppImageArchiveSequence.cpp