tide::MemoryCluster::IteratorBase< BlockType, IterType > Class Template Reference

#include <tide/memory_cluster.h>

List of all members.

Classes
struct	enabler
Public Member Functions
	IteratorBase ()
	Base constructor.
	IteratorBase (IterType iter)
	Constructor.
template<typename OtherType , typename OtherIterType >
	IteratorBase (IteratorBase< OtherType, OtherIterType > const &other)
	Templated base constructor.
Protected Member Functions
void	increment ()
	Increment the Iterator to the next block.
void	decrement ()
	Decrement the Iterator to the previous block.
template<typename OtherType , typename OtherIterType >
bool	equal (IteratorBase< OtherType, OtherIterType > const &other) const
	Test for equality with another Iterator.
BlockType &	dereference () const
	Dereference the iterator to get the Block pointer.
Protected Attributes
IterType	iter_
Friends
class	boost::iterator_core_access
class	MemoryCluster

---

Detailed Description

template<typename BlockType, typename IterType>
class tide::MemoryCluster::IteratorBase< BlockType, IterType >

Definition at line 69 of file memory_cluster.h.

---

Constructor & Destructor Documentation

template<typename BlockType, typename IterType>

tide::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase

(

)

[inline]

Base constructor.

Definition at line 79 of file memory_cluster.h.

template<typename BlockType, typename IterType>

tide::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase

(

IterType

iter

)

[inline]

Constructor.

Parameters:

[in]

iter

The storage iterator to wrap.

Definition at line 87 of file memory_cluster.h.

template<typename BlockType, typename IterType>

template<typename OtherType , typename OtherIterType >

tide::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase

(

IteratorBase< OtherType, OtherIterType > const &

other

)

[inline]

Templated base constructor.

Used to provide interoperability with compatible iterators.

Definition at line 98 of file memory_cluster.h.

---

Member Function Documentation

template<typename BlockType, typename IterType>

void tide::MemoryCluster::IteratorBase< BlockType, IterType >::decrement

(

)

[inline, protected]

Decrement the Iterator to the previous block.

Definition at line 119 of file memory_cluster.h.

template<typename BlockType, typename IterType>

BlockType& tide::MemoryCluster::IteratorBase< BlockType, IterType >::dereference

(

)

const [inline, protected]

Dereference the iterator to get the Block pointer.

Definition at line 138 of file memory_cluster.h.

template<typename BlockType, typename IterType>

template<typename OtherType , typename OtherIterType >

bool tide::MemoryCluster::IteratorBase< BlockType, IterType >::equal

(

IteratorBase< OtherType, OtherIterType > const &

other

)

const [inline, protected]

Test for equality with another Iterator.

Parameters:

[in]

other

The other iterator.

Definition at line 129 of file memory_cluster.h.

template<typename BlockType, typename IterType>

void tide::MemoryCluster::IteratorBase< BlockType, IterType >::increment

(

)

[inline, protected]

Increment the Iterator to the next block.

Definition at line 113 of file memory_cluster.h.

---

Friends And Related Function Documentation

template<typename BlockType, typename IterType>

friend class boost::iterator_core_access [friend]

Definition at line 105 of file memory_cluster.h.

template<typename BlockType, typename IterType>

friend class MemoryCluster [friend]

Definition at line 108 of file memory_cluster.h.

---

Member Data Documentation

template<typename BlockType, typename IterType>

IterType tide::MemoryCluster::IteratorBase< BlockType, IterType >::iter_ [protected]

Definition at line 110 of file memory_cluster.h.

---

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

• /home/geoff/research/src/tide/include/tide/memory_cluster.h