phObjectList Class Reference
[Lists, Thread Safe]

#include <phObjectList.h>

Inheritance diagram for phObjectList:

List of all members.

---

Detailed Description

The phObjectList is a list that operates with phObjectNodes to create a thread-safe list structure for the storage of any class derived from phObject. This class basically wraps around the phList interface but makes adaptations to take phObject pointers as parameters. In addition, a phObjectList::findObject method will determine if a phObject exists in the list for any purpose such as making sure the phObject exists only once in the list. The methods are renamed to include the term Object so that they will not be mistaken for the phList wrapped methods. The phObjectList also handles much of the creation of the phObjectNode containers by taking only a phObject pointer as a parameter. This greatly simplifies higher level code such as the code in phSystem that makes use of this class. If one wishes the nodes in a phObjectNode to always have the auto delete option enabled, the phObjectNode returned from any of the following methods can be used to enabled it:

• phObjectList::insertObject
• phObjectList::enqueueObject
• phObjectList::pushObject
• phObjectList::unshiftObject.

Definition at line 171 of file phObjectList.h.

Public Member Functions
	phObjectList ()
	~phObjectList ()
phObjectNode *	findObject (phObject *pobj)
phObjectNode *	insertObject (phObject *pobj, uint32_t index=0)
phObject *	removeObject (phObjectNode *node)
phObject *	removeObject (phObject *node)
phObjectNode *	enqueueObject (phObject *pobj)
phObject *	dequeueObject ()
phObjectNode *	pushObject (phObject *pobj)
phObject *	popObject ()
phObjectNode *	unshiftObject (phObject *pobj)
phObject *	shiftObject ()
phObjectNode *	getHeadObject ()
phObjectNode *	getTailObject ()

---

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

• base/include/phObjectList.h
• base/src/phObjectList.cpp

Copyright (C) 2002 - 2007

Philip D.S. Thoren ( pthoren@users.sourceforge.net ) University Of Massachusetts at Lowell Robotics Lab

---