Cpl::Container::DictItem Class Reference

This abstract class represents a item that can be contained in Dictionary. More...

Detailed Description

This abstract class represents a item that can be contained in Dictionary.

The Dictionary is an ordered map implemented as a hash table that can only contain item(s) with same key type. The client sub-class is required to implement the 'getKey() method.

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

#include <DictItem.h>

Inheritance diagram for Cpl::Container::DictItem:

Collaboration diagram for Cpl::Container::DictItem:

Protected Member Functions
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
unsigned int	m_hashCode_
	Remember which hash bucket I am stored in.

Friends
class	HashTable_

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.

Constructor & Destructor Documentation

DictItem() [1/2]

Cpl::Container::DictItem::DictItem ( )

inlineprotected

Constructor.

DictItem() [2/2]

Cpl::Container::DictItem::DictItem ( 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 Function Documentation

getKey()

virtual const Key & Cpl::Container::DictItem::getKey ( ) const

protectedpure virtualnoexcept

This method returns a reference to the Item's Key instance.

The application is responsible for implementing this method.

Implemented in Cpl::MApp::MApp_, Cpl::Text::StringItem, Cpl::TShell::Cmd::Command, and Driver::TPipe::RxFrameHandler.

Member Data Documentation

m_hashCode_

unsigned int Cpl::Container::DictItem::m_hashCode_

protected

Remember which hash bucket I am stored in.

---

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

• Cpl/Container/DictItem.h