opencog::HandleMapIterator< T > Class Template Reference

#include <HandleMap.h>

Public Member Functions
bool	has_next ()
Handle	next () throw (IndexErrorException)

Private Types
typedef std::map< Handle, T > ::iterator	iter_type
typedef std::shared_ptr < HandleMap< T > >	MapPtr

Private Member Functions
	HandleMapIterator (MapPtr m)

Private Attributes
iter_type	current
MapPtr	map

Friends
class	HandleMap< T >

Detailed Description

template<class T>
class opencog::HandleMapIterator< T >

Definition at line 46 of file HandleMap.h.

Member Typedef Documentation

template<class T >

typedef std::map<Handle, T>::iterator opencog::HandleMapIterator< T >::iter_type

private

Stores the current iterator.

Definition at line 218 of file HandleMap.h.

template<class T >

typedef std::shared_ptr<HandleMap<T> > opencog::HandleMapIterator< T >::MapPtr

private

Stores the handleMap.

Definition at line 224 of file HandleMap.h.

Constructor & Destructor Documentation

template<class T >

opencog::HandleMapIterator< T >::HandleMapIterator ( MapPtr  m )

inlineprivate

Constructor for this class.

Parameters

HandleMap

object to be iterated.

Definition at line 232 of file HandleMap.h.

References opencog::HandleMapIterator< T >::current, reorder_log::m, and opencog::HandleMapIterator< T >::map.

Member Function Documentation

template<class T >

bool opencog::HandleMapIterator< T >::has_next ( )

inline

Returns whether there still are elements to be iterated.

Returns

Whether there still are elements to be iterated.

Definition at line 246 of file HandleMap.h.

References opencog::HandleMapIterator< T >::current, and opencog::HandleMapIterator< T >::map.

Here is the caller graph for this function:

template<class T >

Handle opencog::HandleMapIterator< T >::next ( ) throw ( IndexErrorException )

inline

Returns the next key of the iterator and advances.

Returns

Next key of the iterator and advances.

Definition at line 258 of file HandleMap.h.

References opencog::HandleMapIterator< T >::current, opencog::HandleMapIterator< T >::has_next(), and opencog::HandleMapIterator< T >::map.

Friends And Related Function Documentation

template<class T >

friend class HandleMap< T >

friend

Definition at line 211 of file HandleMap.h.

Member Data Documentation

template<class T >

iter_type opencog::HandleMapIterator< T >::current

private

Definition at line 219 of file HandleMap.h.

template<class T >

MapPtr opencog::HandleMapIterator< T >::map

private

Definition at line 225 of file HandleMap.h.

---

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

• opencog/atomutils/HandleMap.h