Cpl::Container::MapItem Class Reference

This abstract class represents a item that can be contained in an Map (aka a sorted list implemented using an AVL tree). More...

Detailed Description

This abstract class represents a item that can be contained in an Map (aka a sorted list implemented using an AVL tree).

The client sub-class is required to implement the 'getKey()' method (from the parent class DictItem).

NOTE: A MapItem can also be contained in a SList and/or a DList (but obviously not at the same time).

#include <MapItem.h>

Inheritance diagram for Cpl::Container::MapItem:

Collaboration diagram for Cpl::Container::MapItem:

Protected Types
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Protected Member Functions
	MapItem ()
	Constructor.
	MapItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor -->special constructor to allow a Map to be statically allocated.
void	initialize (MapItem *parent)
	Initialize the node when being inserted in the tree.
MapItem *	getParent () const
	Get tree connection/pointer.
void	setParent (MapItem *n)
	Set tree connection/pointer.
MapItem *	getLeft () const
	Get tree connection/pointer.
void	setLeft (MapItem *n)
	Set tree connection/pointer.
MapItem *	getRight () const
	Get tree connection/pointer.
void	setRight (MapItem *n)
	Set tree connection/pointer.
Protected Member Functions inherited from Cpl::Container::DictItem
virtual const Key &	getKey () const noexcept=0
	This method returns a reference to the Item's Key instance.
	DictItem ()
	Constructor.
	DictItem (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::ExtendedItem
	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.

Protected Attributes
void *	m_parentPtr_
	Link field to the parent node.
bool	m_is_NOT_root_
	I am the root node.
Balance_T	m_balance_
	Balance status.
Protected Attributes inherited from Cpl::Container::DictItem
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Friends
class	AvlTree_

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.
Public Attributes inherited from Cpl::Container::ExtendedItem
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.

Member Enumeration Documentation

Balance_T

enum Cpl::Container::MapItem::Balance_T

protected

Magic values for balance status.

Constructor & Destructor Documentation

MapItem() [1/2]

Cpl::Container::MapItem::MapItem ( )

inlineprotected

Constructor.

MapItem() [2/2]

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

inlineprotected

Constructor -->special constructor to allow a Map to be statically allocated.

Only the Sorted List itself should ever use this constructor -->not intended for Items in the list

Member Function Documentation

getLeft()

MapItem * Cpl::Container::MapItem::getLeft ( ) const

inlineprotected

Get tree connection/pointer.

getParent()

MapItem * Cpl::Container::MapItem::getParent ( ) const

inlineprotected

Get tree connection/pointer.

getRight()

MapItem * Cpl::Container::MapItem::getRight ( ) const

inlineprotected

Get tree connection/pointer.

initialize()

void Cpl::Container::MapItem::initialize ( MapItem *  parent )

inlineprotected

Initialize the node when being inserted in the tree.

setLeft()

void Cpl::Container::MapItem::setLeft ( MapItem *  n )

inlineprotected

Set tree connection/pointer.

setParent()

void Cpl::Container::MapItem::setParent ( MapItem *  n )

inlineprotected

Set tree connection/pointer.

setRight()

void Cpl::Container::MapItem::setRight ( MapItem *  n )

inlineprotected

Set tree connection/pointer.

Member Data Documentation

m_balance_

Balance_T Cpl::Container::MapItem::m_balance_

protected

Balance status.

m_is_NOT_root_

bool Cpl::Container::MapItem::m_is_NOT_root_

protected

I am the root node.

m_parentPtr_

void* Cpl::Container::MapItem::m_parentPtr_

protected

Link field to the parent node.

---

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

• Cpl/Container/MapItem.h