Tawara  0.1.0
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
tawara::MemoryCluster::IteratorBase< BlockType, IterType > Class Template Reference

#include <tawara/memory_cluster.h>

Inheritance diagram for tawara::MemoryCluster::IteratorBase< BlockType, IterType >:
Inheritance graph
[legend]
Collaboration diagram for tawara::MemoryCluster::IteratorBase< BlockType, IterType >:
Collaboration graph
[legend]

Public Member Functions

 IteratorBase ()
 Base constructor. More...
 
 IteratorBase (IterType iter)
 Constructor. More...
 
template<typename OtherType , typename OtherIterType >
 IteratorBase (IteratorBase< OtherType, OtherIterType > const &other)
 Templated base constructor. More...
 

Protected Member Functions

void increment ()
 Increment the Iterator to the next block. More...
 
void decrement ()
 Decrement the Iterator to the previous block. More...
 
template<typename OtherType , typename OtherIterType >
bool equal (IteratorBase< OtherType, OtherIterType > const &other) const
 Test for equality with another Iterator. More...
 
BlockType & dereference () const
 Dereference the iterator to get the Block pointer. More...
 

Protected Attributes

IterType iter_
 

Friends

class boost::iterator_core_access
 
class MemoryCluster
 

Detailed Description

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

Definition at line 83 of file memory_cluster.h.

Constructor & Destructor Documentation

template<typename BlockType, typename IterType>
tawara::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase ( )
inline

Base constructor.

Definition at line 93 of file memory_cluster.h.

template<typename BlockType, typename IterType>
tawara::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase ( IterType  iter)
inline

Constructor.

Parameters
[in]iterThe storage iterator to wrap.

Definition at line 101 of file memory_cluster.h.

template<typename BlockType, typename IterType>
template<typename OtherType , typename OtherIterType >
tawara::MemoryCluster::IteratorBase< BlockType, IterType >::IteratorBase ( IteratorBase< OtherType, OtherIterType > const &  other)
inline

Templated base constructor.

Used to provide interoperability with compatible iterators.

Definition at line 112 of file memory_cluster.h.

Member Function Documentation

template<typename BlockType, typename IterType>
void tawara::MemoryCluster::IteratorBase< BlockType, IterType >::decrement ( )
inlineprotected

Decrement the Iterator to the previous block.

Definition at line 133 of file memory_cluster.h.

template<typename BlockType, typename IterType>
BlockType& tawara::MemoryCluster::IteratorBase< BlockType, IterType >::dereference ( ) const
inlineprotected

Dereference the iterator to get the Block pointer.

Definition at line 152 of file memory_cluster.h.

template<typename BlockType, typename IterType>
template<typename OtherType , typename OtherIterType >
bool tawara::MemoryCluster::IteratorBase< BlockType, IterType >::equal ( IteratorBase< OtherType, OtherIterType > const &  other) const
inlineprotected

Test for equality with another Iterator.

Parameters
[in]otherThe other iterator.

Definition at line 143 of file memory_cluster.h.

template<typename BlockType, typename IterType>
void tawara::MemoryCluster::IteratorBase< BlockType, IterType >::increment ( )
inlineprotected

Increment the Iterator to the next block.

Definition at line 127 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 119 of file memory_cluster.h.

template<typename BlockType, typename IterType>
friend class MemoryCluster
friend

Definition at line 122 of file memory_cluster.h.

Member Data Documentation

template<typename BlockType, typename IterType>
IterType tawara::MemoryCluster::IteratorBase< BlockType, IterType >::iter_
protected

Definition at line 124 of file memory_cluster.h.


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