Cpl::MApp::MApp_ Class Reference

This partial concrete class provide common infrastructure that is common to all MApp instances. More...

Detailed Description

This partial concrete class provide common infrastructure that is common to all MApp instances.

#include <MApp_.h>

Inheritance diagram for Cpl::MApp::MApp_:

Collaboration diagram for Cpl::MApp::MApp_:

Public Member Functions
const char *	getName () const noexcept
	See Cpl::MApp::Api.
const char *	getDescription () const noexcept
	See Cpl::MApp::Api.
const char *	getUsage () const noexcept
	See Cpl::MApp::Api.
Public Member Functions inherited from Cpl::MApp::MAppApi
virtual void	intialize_ () noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	shutdown_ () noexcept=0
	This method has PACKAGE Scope, i.e.
virtual bool	start_ (char *optionalArgs) noexcept=0
	This method has PACKAGE Scope, i.e.
virtual void	stop_ () noexcept=0
	This method has PACKAGE Scope, i.e.
virtual	~MAppApi ()
	Virtual destructor.
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.

Protected Member Functions
	MApp_ (Cpl::Container::Map< MAppApi > &mappList, const char *mappName, const char *description, const char *usage)
	Constructor.
const Cpl::Container::Key &	getKey () const noexcept
	See Cpl::Container::Key.
Protected Member Functions inherited from Cpl::Container::MapItem
	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
	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
Cpl::Container::KeyLiteralString	m_name
	Command name.
const char *	m_description
	Description.
const char *	m_usage
	Usage.
bool	m_started
	Started state.
Protected Attributes inherited from Cpl::Container::MapItem
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.

Additional Inherited Members
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.
Protected Types inherited from Cpl::Container::MapItem
enum	Balance_T { eLEFT_ =-1 , eEVEN_ =0 , eRIGHT_ =1 }
	Magic values for balance status. More...

Constructor & Destructor Documentation

MApp_()

Cpl::MApp::MApp_::MApp_ ( Cpl::Container::Map< MAppApi > &  mappList, const char *  mappName, const char *  description, const char *  usage  )

protected

Constructor.

Member Function Documentation

getDescription()

const char * Cpl::MApp::MApp_::getDescription ( ) const

virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

getKey()

const Cpl::Container::Key & Cpl::MApp::MApp_::getKey ( ) const

protectedvirtualnoexcept

See Cpl::Container::Key.

Implements Cpl::Container::DictItem.

getName()

const char * Cpl::MApp::MApp_::getName ( ) const

virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

getUsage()

const char * Cpl::MApp::MApp_::getUsage ( ) const

virtualnoexcept

See Cpl::MApp::Api.

Implements Cpl::MApp::MAppApi.

Member Data Documentation

m_description

const char* Cpl::MApp::MApp_::m_description

protected

Description.

m_name

Cpl::Container::KeyLiteralString Cpl::MApp::MApp_::m_name

protected

Command name.

m_started

bool Cpl::MApp::MApp_::m_started

protected

Started state.

m_usage

const char* Cpl::MApp::MApp_::m_usage

protected

Usage.

---

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

• Cpl/MApp/MApp_.h