This partially concrete class provides functionality that is common to all Frame handlers. More...

Detailed Description

This partially concrete class provides functionality that is common to all Frame handlers.

Most notably, this class implements the self-registration of a Frame handler. All concrete Frame Handler classes should inherit from this class.

#include <RxFrameHandler.h>

Inheritance diagram for Driver::TPipe::RxFrameHandler:

[legend]

Collaboration diagram for Driver::TPipe::RxFrameHandler:

[legend]

Public Member Functions
const char *	getVerb () const noexcept
	See Driver::TPipe::RxFrameHandlerApi.

Public Member Functions inherited from Driver::TPipe::RxFrameHandlerApi
virtual void	execute (char *decodedFrameText) noexcept=0
	This method is execute when an valid frame is received AND the frame begins with the frame handler' verb (as defined by its getVerb() method).

virtual	~RxFrameHandlerApi ()
	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
	RxFrameHandler (Cpl::Container::Map< RxFrameHandlerApi > &handlerList, const char *verb) noexcept
	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_mapKey
	Verb.

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

◆ RxFrameHandler()

Driver::TPipe::RxFrameHandler::RxFrameHandler	(	Cpl::Container::Map< RxFrameHandlerApi > &	handlerList,
		const char *	verb )

protectednoexcept

Constructor.

Member Function Documentation

◆ getKey()

const Cpl::Container::Key & Driver::TPipe::RxFrameHandler::getKey ( ) const

protectedvirtualnoexcept

See Cpl::Container::Key.

Implements Cpl::Container::DictItem.

◆ getVerb()

const char * Driver::TPipe::RxFrameHandler::getVerb ( ) const

virtualnoexcept

See Driver::TPipe::RxFrameHandlerApi.

Implements Driver::TPipe::RxFrameHandlerApi.

Member Data Documentation

◆ m_mapKey

Cpl::Container::KeyLiteralString Driver::TPipe::RxFrameHandler::m_mapKey

protected

Verb.

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

Driver/TPipe/RxFrameHandler.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes