Detailed Description

template<typename Data>
class Util::Node< Data >

Linked List Node, class template.

Definition at line 22 of file Node.h.

#include <Node.h>

Public Member Functions
	Node ()
	Default constructor. More...

	Node (const Node< Data > &other)
	Copy constructor. More...

Node< Data > *	next () const
	Get the next pointer. More...

Node< Data > *	prev () const
	Get the previous pointer. More...

const Data &	data () const
	Get a const reference to the associated Data. More...

Data &	data ()
	Get a reference to the associated Data object. More...

List< Data > &	list () const
	Get a reference to the List. More...

void	setNext (Node< Data > *next)
	Set pointer to the next Node. More...

void	setPrev (Node< Data > *prev)
	Set pointer to the previous Node. More...

void	setList (List< Data > &list)
	Set the list. More...

void	setList (List< Data > *list)
	Set the list. More...

void	attachNext (Node< Data > &other)
	Set pointers connecting the other node after this node. More...

void	attachPrev (Node< Data > &other)
	Set pointers connecting the other node before this node. More...

void	clear ()
	Nullify previous and next pointers, and nullify the list pointer. More...

Constructor & Destructor Documentation

template<typename Data>

Util::Node< Data >::Node ( )

inline

Default constructor.

Definition at line 30 of file Node.h.

template<typename Data>

Util::Node< Data >::Node ( const Node< Data > & other )

inline

Copy constructor.

Definition at line 40 of file Node.h.

Member Function Documentation

template<typename Data>

Node<Data>* Util::Node< Data >::next ( ) const

inline

Get the next pointer.

Returns: pointer to next Node in List.

Definition at line 52 of file Node.h.

Referenced by Util::List< Data >::insert(), Util::List< Data >::insertNext(), Util::List< Data >::isValid(), Util::List< Data >::popFront(), Util::List< Data >::remove(), and Util::Node< Data >::setNext().

template<typename Data>

Node<Data>* Util::Node< Data >::prev ( ) const

inline

Get the previous pointer.

Returns: pointer to previous Node in List.

Definition at line 60 of file Node.h.

Referenced by Util::List< Data >::insertPrev(), Util::List< Data >::isValid(), Util::List< Data >::popBack(), Util::List< Data >::remove(), and Util::Node< Data >::setPrev().

template<typename Data>

const Data& Util::Node< Data >::data ( ) const

inline

Get a const reference to the associated Data.

Returns: Data object associated with this Node.

Definition at line 68 of file Node.h.

template<typename Data>

Data& Util::Node< Data >::data ( )

inline

Get a reference to the associated Data object.

Returns: Data object associated with this Node.

Definition at line 76 of file Node.h.

template<typename Data>

List<Data>& Util::Node< Data >::list ( ) const

inline

Get a reference to the List.

Returns: Reference to the list to which this Node belongs.

Definition at line 84 of file Node.h.

Referenced by Util::List< Data >::insert(), Util::List< Data >::isValid(), Util::List< Data >::remove(), and Util::Node< Data >::setList().

template<typename Data>

void Util::Node< Data >::setNext ( Node< Data > * next )

inline

Set pointer to the next Node.

Parameters

next	pointer to next Node

Definition at line 92 of file Node.h.

References Util::Node< Data >::next().

Referenced by Util::List< Data >::insert(), Util::List< Data >::insertNext(), and Util::List< Data >::pushBack().

template<typename Data>

void Util::Node< Data >::setPrev ( Node< Data > * prev )

inline

Set pointer to the previous Node.

Parameters

prev	pointer to previous Node

Definition at line 100 of file Node.h.

References Util::Node< Data >::prev().

Referenced by Util::List< Data >::insert(), Util::List< Data >::insertPrev(), and Util::List< Data >::pushFront().

template<typename Data>

void Util::Node< Data >::setList ( List< Data > & list )

inline

Set the list.

Parameters

list	associated List object

Definition at line 108 of file Node.h.

References Util::Node< Data >::list().

Referenced by Util::List< Data >::insert(), Util::List< Data >::pushBack(), and Util::List< Data >::pushFront().

template<typename Data>

void Util::Node< Data >::setList ( List< Data > * list )

inline

Set the list.

Parameters

list	pointer to an associated List object

Definition at line 116 of file Node.h.

References Util::Node< Data >::list().

template<typename Data>

void Util::Node< Data >::attachNext ( Node< Data > & other )

inline

Set pointers connecting the other node after this node.

This method sets the next pointer of this node to other and the previous node of other to this. It also also sets the list of the other node to this list.

It does not reset the next pointer of the other node, and so does not finish splicing the other node into the middle of this list. The next pointer of the other node is left unchanged.

Parameters

other a Node to connect to this one.

Definition at line 132 of file Node.h.

Referenced by Util::List< Data >::insert(), and Util::List< Data >::insertNext().

template<typename Data>

void Util::Node< Data >::attachPrev ( Node< Data > & other )

inline

Set pointers connecting the other node before this node.

This method sets the previous pointer of this node to other and the next node of other to this. It also also sets the list of the other node to this list.

It does not reset the previous pointer of the other node, and so does not finish splicing the other node into the middle of this list. The previous pointer of the other node is left unchanged.

Parameters

other a Node to connect to this one.

Definition at line 152 of file Node.h.

Referenced by Util::List< Data >::insertPrev().

template<typename Data>

void Util::Node< Data >::clear ( )

inline

Nullify previous and next pointers, and nullify the list pointer.

This method disconnects the Node from any List, but does not modify the datum_.

Definition at line 165 of file Node.h.

Referenced by Util::List< Data >::popBack(), Util::List< Data >::popFront(), and Util::List< Data >::remove().

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