FreeNOS: ListIterator< T > Class Template Reference

FreeNOS

Iterate through a List. More...

#include <ListIterator.h>

Inheritance diagram for ListIterator< T >:

Public Member Functions
	ListIterator (List< T > *list)
	Class constructor.

	ListIterator (List< T > &list)
	Class constructor.

	ListIterator (const List< T > &list)
	Constant class constructor.

virtual void	reset ()
	Reset the iterator.

virtual bool	hasNext () const
	Check if there is more on the List to iterate.

virtual bool	hasCurrent () const
	Check if there is a current item on the List.

virtual const T &	current () const
	Get current item in the List.

virtual T &	current ()
	Get current item in the List.

virtual T &	next ()
	Fetch the next item.

virtual bool	remove ()
	Remove the current item from the List.

virtual void	operator++ (int num)
	Increment operator.

Public Member Functions inherited from Iterator< T >
virtual	~Iterator ()
	Destructor.

Private Attributes
List< T > &	m_list
	Points to the List to iterate.

class List< T >::Node *	m_current
	Current node.

class List< T >::Node *	m_next
	Next node.

Detailed Description

template<class T>
class ListIterator< T >

Iterate through a List.

Definition at line 37 of file ListIterator.h.

Constructor & Destructor Documentation

◆ ListIterator() [1/3]

template<class T >

ListIterator< T >::ListIterator ( List< T > * list )

inline

Class constructor.

Parameters

list	Reference to the List to iterate.

Definition at line 46 of file ListIterator.h.

References ListIterator< T >::m_current, ListIterator< T >::reset(), and ZERO.

◆ ListIterator() [2/3]

template<class T >

ListIterator< T >::ListIterator ( List< T > & list )

inline

Class constructor.

Parameters

list	Reference to the List to iterate.

Definition at line 59 of file ListIterator.h.

References ListIterator< T >::m_current, ListIterator< T >::reset(), and ZERO.

◆ ListIterator() [3/3]

template<class T >

ListIterator< T >::ListIterator ( const List< T > & list )

inline

Constant class constructor.

Parameters

list	Reference to the List to iterate.

Definition at line 72 of file ListIterator.h.

References ListIterator< T >::m_current, ListIterator< T >::reset(), and ZERO.

Member Function Documentation

◆ current() [1/2]

template<class T >

virtual T & ListIterator< T >::current ( )

inlinevirtual

Get current item in the List.

Returns: Current item.

Implements Iterator< T >.

Definition at line 124 of file ListIterator.h.

References ListIterator< T >::m_current.

◆ current() [2/2]

template<class T >

virtual const T & ListIterator< T >::current ( ) const

inlinevirtual

Get current item in the List.

Returns: Current item.

Implements Iterator< T >.

Definition at line 114 of file ListIterator.h.

References ListIterator< T >::m_current.

Referenced by HashIterator< K, V >::current(), ConstHashIterator< K, V >::current(), HashIterator< K, V >::current(), HashIterator< K, V >::key(), ConstHashIterator< K, V >::key(), HashIterator< K, V >::remove(), MpiProxy::startLocalProcess(), and MpiProxy::startRemoteProcess().

◆ hasCurrent()

template<class T >

virtual bool ListIterator< T >::hasCurrent ( ) const

inlinevirtual

Check if there is a current item on the List.

Returns: True if current item available, false otherwise.

Implements Iterator< T >.

Definition at line 104 of file ListIterator.h.

References ListIterator< T >::m_current, and ZERO.

Referenced by HashTable< K, V >::at(), CoreServer::bootAll(), chdir(), Directory::clear(), Associative< K, V >::compareTo(), Shell::exec(), Kernel::executeIntVector(), FileSystemServer::findFileCache(), Directory::get(), HashTable< K, V >::get(), ConstHashIterator< K, V >::hasCurrent(), HashIterator< K, V >::hasCurrent(), HashTable< K, V >::insert(), LinnCreate::insertDirectory(), DeviceServer::interruptHandler(), ProcessManager::interruptNotify(), HashTable< K, V >::keys(), HashTable< K, V >::keys(), FileSystemServer::lookupFile(), MpiHost::parseHostsFile(), CoreServer::prepareCoreInfo(), Directory::read(), MpiHost::receivePacket(), Directory::remove(), FileSystemServer::retryRequests(), TestRunner::run(), MpiProxy::startLocalProcess(), MpiProxy::startRemoteProcess(), IPV4::toAddress(), HashTable< K, V >::value(), HashTable< K, V >::values(), Directory::~Directory(), and ProcessShares::~ProcessShares().

◆ hasNext()

template<class T >

virtual bool ListIterator< T >::hasNext ( ) const

inlinevirtual

Check if there is more on the List to iterate.

Returns: true if more items, false if not.

Implements Iterator< T >.

Definition at line 94 of file ListIterator.h.

References ListIterator< T >::m_next, and ZERO.

Referenced by Associative< K, V >::clear(), ConstHashIterator< K, V >::hasNext(), and HashIterator< K, V >::hasNext().

◆ next()

template<class T >

virtual T & ListIterator< T >::next ( )

inlinevirtual

Fetch the next item.

8 This function first fetches the next item and then updates the current item pointer to that item. It assumes the iterator has a next item.

Returns: The next item.

See also: hasNext

Implements Iterator< T >.

Definition at line 140 of file ListIterator.h.

References ListIterator< T >::m_current, and ListIterator< T >::m_next.

Referenced by ConstHashIterator< K, V >::next(), HashIterator< K, V >::next(), and ListIterator< T >::remove().

◆ operator++()

template<class T >

virtual void ListIterator< T >::operator++ ( int num )

inlinevirtual

Increment operator.

This function first increment the current item and then updates the next item pointer.

Implements Iterator< T >.

Definition at line 175 of file ListIterator.h.

References ZERO.

◆ remove()

template<class T >

virtual bool ListIterator< T >::remove ( )

inlinevirtual

Remove the current item from the List.

Returns: True if successfull, false otherwise.

Implements Iterator< T >.

Definition at line 153 of file ListIterator.h.

References ListIterator< T >::m_current, ListIterator< T >::m_list, ListIterator< T >::m_next, ListIterator< T >::next(), and ListIterator< T >::remove().

Referenced by HashIterator< K, V >::remove(), and ListIterator< T >::remove().

◆ reset()

template<class T >

virtual void ListIterator< T >::reset ( )

inlinevirtual

Reset the iterator.

Implements Iterator< T >.

Definition at line 83 of file ListIterator.h.

References ListIterator< T >::m_current, ListIterator< T >::m_list, and ListIterator< T >::m_next.

Referenced by ListIterator< T >::ListIterator(), ListIterator< T >::ListIterator(), ListIterator< T >::ListIterator(), ConstHashIterator< K, V >::reset(), and HashIterator< K, V >::reset().

Field Documentation

◆ m_current

template<class T >

class List< T >::Node* ListIterator< T >::m_current

private

Current node.

Definition at line 194 of file ListIterator.h.

Referenced by ListIterator< T >::current(), ListIterator< T >::current(), ListIterator< T >::hasCurrent(), ListIterator< T >::ListIterator(), ListIterator< T >::ListIterator(), ListIterator< T >::ListIterator(), ListIterator< T >::next(), ListIterator< T >::remove(), and ListIterator< T >::reset().

◆ m_list

template<class T >

List<T>& ListIterator< T >::m_list

private

Points to the List to iterate.

Definition at line 191 of file ListIterator.h.

Referenced by ListIterator< T >::remove(), and ListIterator< T >::reset().

◆ m_next

template<class T >

class List< T >::Node* ListIterator< T >::m_next

private

Next node.

Definition at line 197 of file ListIterator.h.

Referenced by ListIterator< T >::hasNext(), ListIterator< T >::next(), ListIterator< T >::remove(), and ListIterator< T >::reset().

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

lib/libstd/ListIterator.h