Realistic 3D camera system: asio::buffers_iterator< BufferSequence, ByteType > Class Template Reference

Realistic 3D camera system

3D camera system components

A random access iterator over the bytes in a buffer sequence. More...

#include <buffers_iterator.hpp>

Public Types
typedef std::ptrdiff_t	difference_type
	The type used for the distance between two iterators. More...

typedef ByteType	value_type
	The type of the value pointed to by the iterator. More...

typedef detail::buffers_iterator_types< BufferSequence, ByteType >::byte_type *	pointer

typedef detail::buffers_iterator_types< BufferSequence, ByteType >::byte_type &	reference

typedef std::random_access_iterator_tag	iterator_category
	The iterator category. More...

Public Member Functions
	buffers_iterator ()
	Default constructor. Creates an iterator in an undefined state. More...

reference	operator* () const
	Dereference an iterator. More...

pointer	operator-> () const
	Dereference an iterator. More...

reference	operator[] (std::ptrdiff_t difference) const
	Access an individual element. More...

buffers_iterator &	operator++ ()
	Increment operator (prefix). More...

buffers_iterator	operator++ (int)
	Increment operator (postfix). More...

buffers_iterator &	operator-- ()
	Decrement operator (prefix). More...

buffers_iterator	operator-- (int)
	Decrement operator (postfix). More...

buffers_iterator &	operator+= (std::ptrdiff_t difference)
	Addition operator. More...

buffers_iterator &	operator-= (std::ptrdiff_t difference)
	Subtraction operator. More...

Static Public Member Functions
static buffers_iterator	begin (const BufferSequence &buffers)
	Construct an iterator representing the beginning of the buffers' data. More...

static buffers_iterator	end (const BufferSequence &buffers)
	Construct an iterator representing the end of the buffers' data. More...

Friends
buffers_iterator	operator+ (const buffers_iterator &iter, std::ptrdiff_t difference)
	Addition operator. More...

buffers_iterator	operator+ (std::ptrdiff_t difference, const buffers_iterator &iter)
	Addition operator. More...

buffers_iterator	operator- (const buffers_iterator &iter, std::ptrdiff_t difference)
	Subtraction operator. More...

std::ptrdiff_t	operator- (const buffers_iterator &a, const buffers_iterator &b)
	Subtraction operator. More...

bool	operator== (const buffers_iterator &a, const buffers_iterator &b)
	Test two iterators for equality. More...

bool	operator!= (const buffers_iterator &a, const buffers_iterator &b)
	Test two iterators for inequality. More...

bool	operator< (const buffers_iterator &a, const buffers_iterator &b)
	Compare two iterators. More...

bool	operator<= (const buffers_iterator &a, const buffers_iterator &b)
	Compare two iterators. More...

bool	operator> (const buffers_iterator &a, const buffers_iterator &b)
	Compare two iterators. More...

bool	operator>= (const buffers_iterator &a, const buffers_iterator &b)
	Compare two iterators. More...

Detailed Description

template<typename BufferSequence, typename ByteType = char>
class asio::buffers_iterator< BufferSequence, ByteType >

A random access iterator over the bytes in a buffer sequence.

Definition at line 73 of file buffers_iterator.hpp.

Member Typedef Documentation

template<typename BufferSequence, typename ByteType = char>

typedef std::ptrdiff_t asio::buffers_iterator< BufferSequence, ByteType >::difference_type

The type used for the distance between two iterators.

Definition at line 81 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

typedef std::random_access_iterator_tag asio::buffers_iterator< BufferSequence, ByteType >::iterator_category

The iterator category.

Definition at line 113 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

typedef detail::buffers_iterator_types< BufferSequence, ByteType>::byte_type* asio::buffers_iterator< BufferSequence, ByteType >::pointer

Definition at line 96 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

typedef detail::buffers_iterator_types< BufferSequence, ByteType>::byte_type& asio::buffers_iterator< BufferSequence, ByteType >::reference

Definition at line 109 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

typedef ByteType asio::buffers_iterator< BufferSequence, ByteType >::value_type

The type of the value pointed to by the iterator.

Definition at line 84 of file buffers_iterator.hpp.

Constructor & Destructor Documentation

template<typename BufferSequence, typename ByteType = char>

asio::buffers_iterator< BufferSequence, ByteType >::buffers_iterator ( )

inline

Default constructor. Creates an iterator in an undefined state.

Definition at line 116 of file buffers_iterator.hpp.

Member Function Documentation

template<typename BufferSequence, typename ByteType = char>

static buffers_iterator asio::buffers_iterator< BufferSequence, ByteType >::begin ( const BufferSequence & buffers )

inlinestatic

Construct an iterator representing the beginning of the buffers' data.

Definition at line 127 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

static buffers_iterator asio::buffers_iterator< BufferSequence, ByteType >::end ( const BufferSequence & buffers )

inlinestatic

Construct an iterator representing the end of the buffers' data.

Definition at line 147 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

reference asio::buffers_iterator< BufferSequence, ByteType >::operator* ( ) const

inline

Dereference an iterator.

Definition at line 166 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator& asio::buffers_iterator< BufferSequence, ByteType >::operator++ ( )

inline

Increment operator (prefix).

Definition at line 186 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator asio::buffers_iterator< BufferSequence, ByteType >::operator++ ( int )

inline

Increment operator (postfix).

Definition at line 193 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator& asio::buffers_iterator< BufferSequence, ByteType >::operator+= ( std::ptrdiff_t difference )

inline

Addition operator.

Definition at line 216 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator& asio::buffers_iterator< BufferSequence, ByteType >::operator-- ( )

inline

Decrement operator (prefix).

Definition at line 201 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator asio::buffers_iterator< BufferSequence, ByteType >::operator-- ( int )

inline

Decrement operator (postfix).

Definition at line 208 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator& asio::buffers_iterator< BufferSequence, ByteType >::operator-= ( std::ptrdiff_t difference )

inline

Subtraction operator.

Definition at line 223 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

pointer asio::buffers_iterator< BufferSequence, ByteType >::operator-> ( ) const

inline

Dereference an iterator.

Definition at line 172 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

reference asio::buffers_iterator< BufferSequence, ByteType >::operator[] ( std::ptrdiff_t difference ) const

inline

Access an individual element.

Definition at line 178 of file buffers_iterator.hpp.

Friends And Related Function Documentation

template<typename BufferSequence, typename ByteType = char>

bool operator!=	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Test two iterators for inequality.

Definition at line 270 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator operator+	(	const buffers_iterator< BufferSequence, ByteType > &	iter,
		std::ptrdiff_t	difference
	)

friend

Addition operator.

Definition at line 230 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator operator+	(	std::ptrdiff_t	difference,
		const buffers_iterator< BufferSequence, ByteType > &	iter
	)

friend

Addition operator.

Definition at line 239 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

buffers_iterator operator-	(	const buffers_iterator< BufferSequence, ByteType > &	iter,
		std::ptrdiff_t	difference
	)

friend

Subtraction operator.

Definition at line 248 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

std::ptrdiff_t operator-	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Subtraction operator.

Definition at line 257 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

bool operator<	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Compare two iterators.

Definition at line 276 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

bool operator<=	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Compare two iterators.

Definition at line 282 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

bool operator==	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Test two iterators for equality.

Definition at line 264 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

bool operator>	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Compare two iterators.

Definition at line 288 of file buffers_iterator.hpp.

template<typename BufferSequence, typename ByteType = char>

bool operator>=	(	const buffers_iterator< BufferSequence, ByteType > &	a,
		const buffers_iterator< BufferSequence, ByteType > &	b
	)

friend

Compare two iterators.

Definition at line 294 of file buffers_iterator.hpp.

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

/home/martin/ver/3DLab/code/asio-1.10.6/include/asio/buffers_iterator.hpp