Cpl::Container::ExtendedItem Class Reference

This class is used by the Container classes to implement a various types of DOUBLY linked containers. More...

Detailed Description

This class is used by the Container classes to implement a various types of DOUBLY linked containers.

Note: Client code, i.e. application code that needs to define a 'containerized' class only needs to inherit from this interface. The Client code SHOULD/SHALL NOT access any of its members or methods! These members/methods are intended to ONLY be accessible by the container classes.

#include <Item.h>

Inheritance diagram for Cpl::Container::ExtendedItem:

Collaboration diagram for Cpl::Container::ExtendedItem:

Public Attributes
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.

Protected Member Functions
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Additional Inherited Members
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Constructor & Destructor Documentation

ExtendedItem() [1/2]

Cpl::Container::ExtendedItem::ExtendedItem ( )

inlineprotected

Constructor.

ExtendedItem() [2/2]

Cpl::Container::ExtendedItem::ExtendedItem ( const char *  ignoreThisParameter_usedToCreateAUniqueConstructor )

inlineprotected

Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Only the Map itself should ever use this constructor -->not intended for Items in a Map

Member Data Documentation

m_prevPtr_

void* Cpl::Container::ExtendedItem::m_prevPtr_

The previous link field.

---

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

• Cpl/Container/Item.h