---

FIFO_LIST Class Template Reference

template class FIFO_LIST. More...

#include <fifo_list.h>

Inheritance diagram for FIFO_LIST::

List of all members.

Public Types
typedef list_type*	handle
	define a handle type to abstract the list_type type. More...
Public Methods
	FIFO_LIST (void)
	class constructor. More...
	~FIFO_LIST (void)
	default destructor does nothing. More...
void	dealloc (void)
	deallocate the list. More...
void	add (T data)
	add an element to the FIFO list. More...
void	reverse (void)
	reverse the list. More...
unsigned int	length (void)
	return the lenght of the list. More...
handle	remove (void)
	remove. More...
T	get_item (handle h)
	given a handle, return the associated data item. More...
handle	first (void)
	get the first element from the list. More...
handle	last (void)
	return the last element in the list. More...
handle	next (handle h)
	iterator to get the next element. More...
Private Attributes
list_type*	list
	list head. More...
list_type*	tail
	list tail (items are added to the tail). More...

---

Detailed Description

template<class T> class FIFO_LIST

template class FIFO_LIST.

This is a generic list type for a list that has both a head and a tail pointer. In this list, items are added to the tail. When read from the front of the list, items will be read in a first-in, first-out order (FIFO). The template should be instantiated with a scalar type, like an integer or a pointer to a larger type (e.g., a string or a structure). For example

      FIFO_LIST<char *> list;
      FIFO_LIST<my_struct *> list;
      FIFO_LIST<my_class *> list;

The list "links" are allocated in a memory pool. This allocation is handled by the local version of new in list_type. The memory allocated for the list_type objects will be deallocated when the memory pool is freed.

Definition at line 64 of file fifo_list.h.

---

Member Typedef Documentation

template<class T> typedef list_type * FIFO_LIST<T>::handle

define a handle type to abstract the list_type type. Definition at line 95 of file fifo_list.h.

---

Constructor & Destructor Documentation

template<class T> FIFO_LIST<T>::FIFO_LIST<T> ( void ) [inline]

class constructor. Definition at line 99 of file fifo_list.h. { list = 0; tail = 0; }

template<class T> FIFO_LIST<T>::~FIFO_LIST<T> ( void ) [inline]

default destructor does nothing. Definition at line 106 of file fifo_list.h. {}

---

Member Function Documentation

template<class T> void FIFO_LIST<T>::add ( T data ) [inline]

add an element to the FIFO list. Definition at line 118 of file fifo_list.h. Referenced by queue::addQueue(), packtree_int::buildBestBasisList(), and packtree::buildBestBasisList(). { list_type *t; t = new list_type(); t->data = data; t->next = 0; if (list == 0) { list = t; tail = t; } else { tail->next = t; tail = t; } } // add

template<class T> void FIFO_LIST<T>::dealloc ( void ) [inline]

deallocate the list. Definition at line 110 of file fifo_list.h. { while ( remove() != 0 ) /* nada */; } // dealloc

template<class T> handle FIFO_LIST<T>::first ( void ) [inline]

get the first element from the list. Definition at line 201 of file fifo_list.h. Referenced by calcPacketWidth(), queue::deleteStart(), invpacktree::invpacktree(), invpacktree_int::invpacktree_int(), packdata_list::pr(), queue::queueEmpty(), and queue::queueStart(). { return list; } // first

template<class T> T FIFO_LIST<T>::get_item ( handle h ) [inline]

given a handle, return the associated data item. Definition at line 193 of file fifo_list.h. Referenced by calcPacketWidth(), queue::deleteStart(), invpacktree::invpacktree(), invpacktree_int::invpacktree_int(), packdata_list::pr(), and queue::queueStart(). { return h->data; } // get_item

template<class T> handle FIFO_LIST<T>::last ( void ) [inline]

return the last element in the list. Definition at line 208 of file fifo_list.h. { return tail; } // last

template<class T> unsigned int FIFO_LIST<T>::length ( void ) [inline]

return the lenght of the list. Definition at line 154 of file fifo_list.h. { list_type *elem; unsigned int cnt = 0; for (elem = list; elem != 0; elem = elem->next) cnt++; return cnt; } // lenght

template<class T> handle FIFO_LIST<T>::next ( handle h ) [inline]

iterator to get the next element. Definition at line 215 of file fifo_list.h. Referenced by calcPacketWidth(), invpacktree::invpacktree(), invpacktree_int::invpacktree_int(), and packdata_list::pr(). { list_type *next = 0; if (h != 0) { next = h->next; } return next; } // next

template<class T> handle FIFO_LIST<T>::remove ( void ) [inline]

remove. Remove an element from the start of the list and return the first element of the remaining list. This function relies on the fact that the list elements were allocated from a pool. The memory for these elements will be recovered when the pool is deallocated. Definition at line 175 of file fifo_list.h. Referenced by dealloc(), and queue::deleteStart(). { list_type *t; if (list != 0) { t = list; list = t->next; // no delete t; } if (list == 0) tail = 0; return list; } // remove

template<class T> void FIFO_LIST<T>::reverse ( void ) [inline]

reverse the list. Definition at line 137 of file fifo_list.h. { list_type *elem, *prev, *next; prev = 0; next = 0; tail = list; for (elem = list; elem != 0; prev = elem, elem = next) { next = elem->next; elem->next = prev; } // for list = prev; } // reverse

---

Member Data Documentation

template<class T> list_type * FIFO_LIST<T>::list [private]

list head. Definition at line 89 of file fifo_list.h.

template<class T> list_type * FIFO_LIST<T>::tail [private]

list tail (items are added to the tail). Definition at line 91 of file fifo_list.h.

---

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

• fifo_list.h

---