Cpl::MApp::Cmd Class Reference

The class implements a TShell command that interacts with the MApp Manager to start, stop, and list available MApp instances. More...

Detailed Description

The class implements a TShell command that interacts with the MApp Manager to start, stop, and list available MApp instances.

#include <Cmd.h>

Inheritance diagram for Cpl::MApp::Cmd:

Collaboration diagram for Cpl::MApp::Cmd:

Public Member Functions
const char *	getUsage () const noexcept
	See Cpl::TShell::Command `.
const char *	getHelp () const noexcept
	See Cpl::TShell::Command.
	Cmd (Cpl::Container::SList< Cpl::TShell::Command > &commandList, Cpl::MApp::ManagerApi &mappManager) noexcept
	Constructor.
Cpl::TShell::Command::Result_T	execute (Cpl::TShell::Context_ &context, char *cmdString, Cpl::Io::Output &outfd) noexcept
	See Cpl::TShell::Command.
Public Member Functions inherited from Cpl::TShell::Cmd::Command
const char *	getVerb () const noexcept
	See Cpl::TShell::Command.
Security::Permission_T	getMinPermissionRequired () const noexcept
	See Cpl::TShell::Command.
Public Member Functions inherited from Cpl::TShell::Command
virtual	~Command ()
	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.

Static Public Attributes
static constexpr const char *	verb = "mapp"
	The command verb/identifier.
static constexpr const char *	usage
	The command usage string.
static constexpr const char *	detailedHelp
	The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

Protected Attributes
Cpl::MApp::ManagerApi &	m_mappManager
	Handle to the MApp manager.
Cpl::MApp::MAppApi *	m_mappList [OPTION_CPL_MAPP_TSHELL_MAX_INSTANCES]
	Array for holding pointers to queried MApp instances.
Protected Attributes inherited from Cpl::TShell::Cmd::Command
const char *	m_verb
	Command verb.
Security::Permission_T	m_minPermissionLevel
	Minimum required user permission need to execute me.

Additional Inherited Members
Public Types inherited from Cpl::TShell::Command
enum	Result_T {   eSUCCESS = 0 , eERROR_BAD_SYNTAX = 1 , eERROR_INVALID_CMD = 2 , eERROR_IO = 3 ,   eERROR_MISSING_ARGS = 4 , eERROR_EXTRA_ARGS = 5 , eERROR_INVALID_ARGS = 6 , eERROR_FAILED = 7 }
	Possible result codes when executing a command. More...
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::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Types inherited from Cpl::TShell::Cmd::Command
enum	CondResult_T { eFALSE , eTRUE , eERROR }
	Result when processing a conditional statement. More...
Protected Member Functions inherited from Cpl::TShell::Cmd::Command
	Command (Cpl::Container::SList< Cpl::TShell::Command > &commandList, const char *verb, Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) noexcept
	Constructor.
Protected Member Functions inherited from Cpl::TShell::Command
	Command ()
	Constructor.
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.

Constructor & Destructor Documentation

Cmd()

Cpl::MApp::Cmd::Cmd ( Cpl::Container::SList< Cpl::TShell::Command > & commandList, Cpl::MApp::ManagerApi & mappManager )

noexcept

Constructor.

Member Function Documentation

execute()

Cpl::TShell::Command::Result_T Cpl::MApp::Cmd::execute ( Cpl::TShell::Context_ & context, char * cmdString, Cpl::Io::Output & outfd )

virtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getHelp()

const char * Cpl::MApp::Cmd::getHelp ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getUsage()

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

inlinevirtualnoexcept

See Cpl::TShell::Command `.

Implements Cpl::TShell::Command.

Member Data Documentation

detailedHelp

constexpr const char* Cpl::MApp::Cmd::detailedHelp

staticconstexpr

Initial value:

= "  Asynchronously starts/stops individual MApps (micro applications).  Issuing\n" 
                                                "  the command without arguments displays the list of running MApps"

The command detailed help string (recommended that lines do not exceed 80 chars) 1 2 3 4 5 6 7 8 12345678901234567890123456789012345678901234567890123456789012345678901234567890.

m_mappList

Cpl::MApp::MAppApi* Cpl::MApp::Cmd::m_mappList[OPTION_CPL_MAPP_TSHELL_MAX_INSTANCES]

protected

Array for holding pointers to queried MApp instances.

m_mappManager

Cpl::MApp::ManagerApi& Cpl::MApp::Cmd::m_mappManager

protected

Handle to the MApp manager.

usage

constexpr const char* Cpl::MApp::Cmd::usage

staticconstexpr

Initial value:

= "mapp\n"
                                         "mapp start <mapp> [<args...]\n"
                                         "mapp stop <mapp>|ALL\n"
                                         "mapp ls"

The command usage string.

verb

constexpr const char* Cpl::MApp::Cmd::verb = "mapp"

staticconstexpr

The command verb/identifier.

---

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

• Cpl/MApp/Cmd.h