Cpl::MApp::MAppApi Class Reference

This abstract class defines the interface for a Micro Application (MApp). More...

Detailed Description

This abstract class defines the interface for a Micro Application (MApp).

A MApp is essentially a 'mini-application' that performs a series of steps and typically reports its output using the CPL_SYSTEM_TRACE_MSG() method.

Multiple MApp instances can be executing at the same. However, all MApps execute in a single/same thread.

The following are the 'thread safety' requirements for a MApp: o Data can safely be exchanged via Model Points o The application can safely pass initial settings, configuration, options when the MApp is started

#include <MAppApi.h>

Inheritance diagram for Cpl::MApp::MAppApi:

Collaboration diagram for Cpl::MApp::MAppApi:

Public Member Functions
virtual const char *	getName () const noexcept=0
	This method returns the MApp name.
virtual const char *	getDescription () const noexcept=0
	This method returns brief description/summary of what the MApp does.
virtual const char *	getUsage () const noexcept=0
	This method returns help for the MApp (optional) command line arguments.
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.

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...
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
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 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.

Constructor & Destructor Documentation

~MAppApi()

virtual Cpl::MApp::MAppApi::~MAppApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

getDescription()

virtual const char * Cpl::MApp::MAppApi::getDescription ( ) const

pure virtualnoexcept

This method returns brief description/summary of what the MApp does.

Typically this information will be displayed on the Debug console to aid the user on how to execute the MApp. The content/verbosity of the text is MApp specific.

Implemented in Cpl::MApp::MApp_.

getName()

virtual const char * Cpl::MApp::MAppApi::getName ( ) const

pure virtualnoexcept

This method returns the MApp name.

The MApp name must an printable ASCII string with NO whitespace. The name is used to uniquely identify the individual MApp

Implemented in Cpl::MApp::MApp_.

getUsage()

virtual const char * Cpl::MApp::MAppApi::getUsage ( ) const

pure virtualnoexcept

This method returns help for the MApp (optional) command line arguments.

Typically this information will be displayed on the Debug console to aid the user on how to execute the MApp. The content/verbosity of the text is MApp specific.

Implemented in Cpl::MApp::MApp_.

intialize_()

virtual void Cpl::MApp::MAppApi::intialize_ ( )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::MApp namespace. The Application should NEVER call this method.

This method is used to perform any needed initialization on start-up of Application. This method is called when the MApp Manager is opened.

This method MUST be called in the thread that the MApp executes in.

Implemented in Cpl::MApp::Temperature::Api, Eros::Test::Cycle::Api, and Eros::Test::Thermistor::Api.

shutdown_()

virtual void Cpl::MApp::MAppApi::shutdown_ ( )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::MApp namespace. The Application should NEVER call this method.

This method is used to perform any needed shutdown when the application is shutdown. This method is called when the MApp Manager is closed.

This method MUST be called in the thread that the MApp executes in.

Implemented in Cpl::MApp::Temperature::Api, Eros::Test::Cycle::Api, and Eros::Test::Thermistor::Api.

start_()

virtual bool Cpl::MApp::MAppApi::start_ ( char *  optionalArgs )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::MApp namespace. The Application should NEVER call this method, instead the Application must call the Manager to start a MApp.

If the client has no 'optionalArgs' to pass to the MApp instance - it must provide an empty/blank null terminated string, i.e can NOT pass a nullptr.

This method is used to start a MApp. If the MApp is unable to start then false is returned; else true is returned.

This method MUST be called in the thread that the MApp executes in.

Note: The MApp is allowed to perform destructive parsing on 'optionalArgs', however it must honor the string len of 'optionalArgs'

Implemented in Cpl::MApp::Temperature::Api, Eros::Test::Cycle::Api, and Eros::Test::Thermistor::Api.

stop_()

virtual void Cpl::MApp::MAppApi::stop_ ( )

pure virtualnoexcept

This method has PACKAGE Scope, i.e.

it is intended to be ONLY accessible by other classes in the Cpl::MApp namespace. The Application should NEVER call this method, instead the Application must call the Manager to stop a MApp.

This method is used to stop a MApp.

Implemented in Cpl::MApp::Temperature::Api, Eros::Test::Cycle::Api, and Eros::Test::Thermistor::Api.

---

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

• Cpl/MApp/MAppApi.h