Cpl::Container::DList< ITEM > Class Template Reference

This template class implements a Doubly linked list which maintains the ordering imposed on it by the application. More...

Detailed Description

template<class ITEM>
class Cpl::Container::DList< ITEM >

This template class implements a Doubly linked list which maintains the ordering imposed on it by the application.

NOTE: ITEM must be a subclass of ExtendedItem.

#include <DList.h>

Inheritance diagram for Cpl::Container::DList< ITEM >:

Public Member Functions
	DList () noexcept
	Public constructor initializes head and tail pointers.
	DList (const char *ignoreThisParameter_usedToCreateAUniqueConstructor) noexcept
	This is a special constructor for when the list is statically declared (i.e.
Operations on the List itself
void	move (DList< ITEM > &dst)
	Moves the content of the this List to the specified List.
void	clearTheList ()
	Empties the list.
View as a FIFO
ITEM *	get (void) noexcept
	Removes the first item in the list.
void	put (ITEM &item) noexcept
	Adds the item as the last item in the list.
ITEM *	head (void) const noexcept
	Return a pointer to the first item in the list.
ITEM *	tail (void) const noexcept
	Return a pointer to the last item in the list.
View as a STACK
ITEM *	pop (void) noexcept
	Removes the top element from stack and return a pointer to it as a result.
void	push (ITEM &item) noexcept
	Adds the ITEM item to top of the stack.
ITEM *	top (void) const noexcept
	Return a pointer to the top ITEM item in the stack.
View as Ordered List
ITEM *	getFirst (void) noexcept
	Removes the first item in the list.
ITEM *	getLast (void) noexcept
	Removes the last item in the list.
void	putFirst (ITEM &item) noexcept
	Adds the item as the first item in the list.
void	putLast (ITEM &item) noexcept
	Adds the item as the last item in the list.
bool	remove (ITEM &item) noexcept
	Remove specified ITEM element from the list.
void	insertAfter (ITEM &after, ITEM &item) noexcept
	Insert the "item" ITEM into the list behind the "after" ITEM element.
void	insertBefore (ITEM &before, ITEM &item) noexcept
	Insert the "item" ITEM into the list ahead of the "before" ITEM element.
bool	find (const ITEM &item) const noexcept
	Returns true of the specified item/pointer is already in the list, else false.
ITEM *	first (void) const noexcept
	Return a pointer to the first item in the list.
ITEM *	last (void) const noexcept
	Return a pointer to the last item in the list.
ITEM *	next (ITEM &current) const noexcept
	Return a pointer to the item after the item "current".
ITEM *	previous (ITEM &current) const noexcept
	Return a pointer to the item before the item "current".

Constructor & Destructor Documentation

DList() [1/2]

template<class ITEM >

Cpl::Container::DList< ITEM >::DList ( void  )

noexcept

Public constructor initializes head and tail pointers.

DList() [2/2]

template<class ITEM >

Cpl::Container::DList< ITEM >::DList ( const char *  ignoreThisParameter_usedToCreateAUniqueConstructor )

noexcept

This is a special constructor for when the list is statically declared (i.e.

it is initialized as part of C++ startup BEFORE main() is executed. C/C++ guarantees that all statically declared data will be initialized to zero by default (see r.8.4 in C++ Programming Language, Second Edition). Since the head & tail pointers are initialized to zero - then the C/C++ default is OK. Why do I care about all this? Because if you attempt to build static list(s), then the order of when the list is constructed vs. when the static elements are added to the list is a problem! To avoid this problem, a alternate constructor that does NOT initialize the head & tail pointers is provided. It assumes that the pointers are already set zero because the list is "static". Whew!

Member Function Documentation

clearTheList()

template<class ITEM >

void Cpl::Container::DList< ITEM >::clearTheList ( )

inline

Empties the list.

All references to the item(s) in the list are lost.

find()

template<class ITEM >

bool Cpl::Container::DList< ITEM >::find ( const ITEM &  item ) const

inlinenoexcept

Returns true of the specified item/pointer is already in the list, else false.

first()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::first ( void  ) const

inlinenoexcept

Return a pointer to the first item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

get()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::get ( void  )

inlinenoexcept

Removes the first item in the list.

Returns 0 if the list is empty.

getFirst()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::getFirst ( void  )

inlinenoexcept

Removes the first item in the list.

Returns 0 if the list is empty.

getLast()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::getLast ( void  )

inlinenoexcept

Removes the last item in the list.

Returns 0 if the list is empty.

head()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::head ( void  ) const

inlinenoexcept

Return a pointer to the first item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

insertAfter()

template<class ITEM >

void Cpl::Container::DList< ITEM >::insertAfter ( ITEM &  after, ITEM &  item  )

inlinenoexcept

Insert the "item" ITEM into the list behind the "after" ITEM element.

If 'after' is 0, then 'item' is added to the head of the list.

insertBefore()

template<class ITEM >

void Cpl::Container::DList< ITEM >::insertBefore ( ITEM &  before, ITEM &  item  )

inlinenoexcept

Insert the "item" ITEM into the list ahead of the "before" ITEM element.

If 'before' is 0, then 'item' is added to the tail of the list.

last()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::last ( void  ) const

inlinenoexcept

Return a pointer to the last item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

move()

template<class ITEM >

void Cpl::Container::DList< ITEM >::move ( DList< ITEM > &  dst )

inline

Moves the content of the this List to the specified List.

next()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::next ( ITEM &  current ) const

inlinenoexcept

Return a pointer to the item after the item "current".

Both items remain in the list. Returns 0 when the end-of-list is reached.

pop()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::pop ( void  )

inlinenoexcept

Removes the top element from stack and return a pointer to it as a result.

Returns 0, if the stack is empty

previous()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::previous ( ITEM &  current ) const

inlinenoexcept

Return a pointer to the item before the item "current".

Both items remain in the list. Returns 0 when the end-of-list is reached.

push()

template<class ITEM >

void Cpl::Container::DList< ITEM >::push ( ITEM &  item )

inlinenoexcept

Adds the ITEM item to top of the stack.

put()

template<class ITEM >

void Cpl::Container::DList< ITEM >::put ( ITEM &  item )

inlinenoexcept

Adds the item as the last item in the list.

putFirst()

template<class ITEM >

void Cpl::Container::DList< ITEM >::putFirst ( ITEM &  item )

inlinenoexcept

Adds the item as the first item in the list.

putLast()

template<class ITEM >

void Cpl::Container::DList< ITEM >::putLast ( ITEM &  item )

inlinenoexcept

Adds the item as the last item in the list.

remove()

template<class ITEM >

bool Cpl::Container::DList< ITEM >::remove ( ITEM &  item )

inlinenoexcept

Remove specified ITEM element from the list.

Returns true, if the specified element was found and removed from the list, else false.

tail()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::tail ( void  ) const

inlinenoexcept

Return a pointer to the last item in the list.

The returned item remains in the list. Returns 0 if the list is empty.

top()

template<class ITEM >

ITEM * Cpl::Container::DList< ITEM >::top ( void  ) const

inlinenoexcept

Return a pointer to the top ITEM item in the stack.

The returned item remains in the queue. Returns 0 if the stack is empty.

---

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

• Cpl/Container/DList.h