container::LinkedList::Node Class Reference

LinkedList uses Node objects to form a list of Entity objects. More...

#include <linkedlist.h>

Collaboration diagram for container::LinkedList::Node:

[legend]

List of all members.

Public Member Functions
	Node ()
	Node (Entity *e, Node *n)
	Construct a Node for Entity e and insert it into the list before Node n.
	~Node ()
Entity *	extractEntity ()
Public Attributes
Node *	next
Node *	prev
Entity *	entity

---

Detailed Description

LinkedList uses Node objects to form a list of Entity objects.

Node is doubly linked. It keeps a pointer to its Entity object and expects it to be dynamically allocated. Node takes responsibility for deleting its Entity object during Node destruction.

Todo:

Break node out from LinkedList, or at least provide a .h file. A Node could be used like an iterator. There is some functionality like toNext() and toPrev() that should be encapsulated in Node instead of LinkedList. Node could be re-used as the building block for other linked list type structures.

---

Constructor & Destructor Documentation

container::LinkedList::Node::Node

(

)

: next(NULL), prev(NULL), entity(NULL) { }

container::LinkedList::Node::Node	(	Entity *	e,
		Node *	n
	)

Construct a Node for Entity e and insert it into the list before Node n.

Precondition:

n points to a Node that is part of a correctly formed linked list structure

e points to an Entity

Postcondition:

The newly constructed Node is in the linked list structure before Node n

                                      : next(n), prev(n->prev), entity(e) {
   // Tell the list where this new node belongs
   next->prev = this;
   prev->next = this;
}

container::LinkedList::Node::~Node

(

)

                      {
   // Remove itself from the list
   if (prev != NULL) {
      prev->next = next;
   }

   if (next != NULL) {
      next->prev = prev;
   }

   // Delete its entity
   if (entity != NULL) {
      delete entity;
   }
}

---

Member Function Documentation

Entity * container::LinkedList::Node::extractEntity

(

)

                                       {
   Entity *e = entity;
   entity = NULL;
   return e;
}

Here is the caller graph for this function:

---

Member Data Documentation

Entity* container::LinkedList::Node::entity

Node* container::LinkedList::Node::next

Node* container::LinkedList::Node::prev

---

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

• linkedlist.h
• linkedlist.cpp