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

Detailed Description

This class is used by the Container classes to implement a various types of singly 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::Item:

[legend]

Public Member Functions
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
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
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Member Functions
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

◆ Item() [1/2]

Cpl::Container::Item::Item ( )

inlineprotected

Constructor.

◆ Item() [2/2]

Cpl::Container::Item::Item ( const char * )

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

◆ insert_()

bool Cpl::Container::Item::insert_ ( void * newContainerPtr )

Helper method to trap when inserting an item in multiple containers.

A fatal error will be generated if 'Item' is attempted to be put into more than on container.

Notes: o The method returns false when there is error - which is ONLY usefully during unittesting when the invoking a FatalError does NOT terminate the application.

◆ isInContainer_()

bool Cpl::Container::Item::isInContainer_ ( const void * containerPtr ) const

noexcept

Returns 'true' if the instance is in the specified container.

◆ remove_()

static void Cpl::Container::Item::remove_ ( Item * itemPtr )

staticnoexcept

Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Member Data Documentation

◆ m_inListPtr_

void* Cpl::Container::Item::m_inListPtr_

Debug field.

This member is used to trap when there is an attempt to insert a item into a container when it is already in a container

◆ m_nextPtr_

void* Cpl::Container::Item::m_nextPtr_

The link field.

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

Cpl/Container/Item.h