Cpl::TShell::Command Class Reference

This class defines the interface for a TShell command. More...

Detailed Description

This class defines the interface for a TShell command.

#include <Command.h>

Inheritance diagram for Cpl::TShell::Command:

Collaboration diagram for Cpl::TShell::Command:

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

Public Member Functions
virtual Result_T	execute (Context_ &context, char *rawCmdString, Cpl::Io::Output &outfd) noexcept=0
	This method executes the command.
virtual const char *	getVerb () const noexcept=0
	This method returns the command's verb string.
virtual const char *	getUsage () const noexcept=0
	This method returns the command's usage string.
virtual const char *	getHelp () const noexcept=0
	This method returns the command's detailed help string.
virtual Security::Permission_T	getMinPermissionRequired () const noexcept=0
	Returns the minimum required permission level needed to execute the 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.

Protected Member Functions
	Command ()
	Constructor.
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.

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

Member Enumeration Documentation

Result_T

enum Cpl::TShell::Command::Result_T

Possible result codes when executing a command.

Enumerator
eSUCCESS	Command executed successfully.
eERROR_BAD_SYNTAX	The command string cannot be parsed.
eERROR_INVALID_CMD	Not a valid/supported command (Note: Typically this is only returned by the Command Processor - not individual commands)
eERROR_IO	Command failed due to an error writing to the Output stream.
eERROR_MISSING_ARGS	Command failed due to execute due to missing one or more required arguments.
eERROR_EXTRA_ARGS	Command failed due to execute due to unexpected 'extra' arguments.
eERROR_INVALID_ARGS	Command failed due to execute due to one or more arguments being invalid.
eERROR_FAILED	Command failed to complete one or more of actions.

Constructor & Destructor Documentation

Command()

Cpl::TShell::Command::Command ( )

inlineprotected

Constructor.

~Command()

virtual Cpl::TShell::Command::~Command ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

execute()

virtual Result_T Cpl::TShell::Command::execute ( Context_ &  context, char *  rawCmdString, Cpl::Io::Output &  outfd  )

pure virtualnoexcept

This method executes the command.

Implemented in Cpl::TShell::Cmd::Arduino::Dbg, Ajax::Heating::Simulated::Cmd, Ajax::TShell::Provision, Ajax::TShell::State, Ajax::TShell::Ui, Cpl::Dm::TShell::Dm, Cpl::Io::File::Littlefs::TShell::Fs, Cpl::Logging::TShell::Log, Cpl::MApp::Cmd, Cpl::TShell::Cmd::Bye, Cpl::TShell::Cmd::Help, Cpl::TShell::Cmd::Threads, Cpl::TShell::Cmd::Tick, Cpl::TShell::Cmd::TPrint, Cpl::TShell::Cmd::Trace, Cpl::TShell::Cmd::User, Cpl::TShell::Cmd::Wait, Driver::Crypto::TShell::Random, Driver::DIO::InOutCmd, Driver::NV::Cmd, Driver::RHTemp::TShellCmd, Driver::Wifi::Station::TShell::Wifi, Eros::TShell::HwSafety, Eros::TShell::Pwm, and Eros::TShell::Rgb.

getHelp()

virtual const char * Cpl::TShell::Command::getHelp ( ) const

pure virtualnoexcept

This method returns the command's detailed help string.

Detailed help is optional. If the command does not support detailed help, then nullptr is returned.

Implemented in Ajax::Heating::Simulated::Cmd, Ajax::TShell::Provision, Ajax::TShell::State, Ajax::TShell::Ui, Cpl::Dm::TShell::Dm, Cpl::Io::File::Littlefs::TShell::Fs, Cpl::Logging::TShell::Log, Cpl::MApp::Cmd, Cpl::TShell::Cmd::Arduino::Dbg, Cpl::TShell::Cmd::Bye, Cpl::TShell::Cmd::Help, Cpl::TShell::Cmd::Threads, Cpl::TShell::Cmd::Tick, Cpl::TShell::Cmd::TPrint, Cpl::TShell::Cmd::Trace, Cpl::TShell::Cmd::User, Cpl::TShell::Cmd::Wait, Driver::Crypto::TShell::Random, Driver::DIO::InOutCmd, Driver::NV::Cmd, Driver::RHTemp::TShellCmd, Driver::Wifi::Station::TShell::Wifi, Eros::TShell::HwSafety, Eros::TShell::Pwm, and Eros::TShell::Rgb.

getMinPermissionRequired()

virtual Security::Permission_T Cpl::TShell::Command::getMinPermissionRequired ( ) const

pure virtualnoexcept

Returns the minimum required permission level needed to execute the command.

Implemented in Cpl::TShell::Cmd::Command.

getUsage()

virtual const char * Cpl::TShell::Command::getUsage ( ) const

pure virtualnoexcept

This method returns the command's usage string.

Implemented in Ajax::Heating::Simulated::Cmd, Ajax::TShell::Provision, Ajax::TShell::State, Ajax::TShell::Ui, Cpl::Dm::TShell::Dm, Cpl::Io::File::Littlefs::TShell::Fs, Cpl::Logging::TShell::Log, Cpl::MApp::Cmd, Cpl::TShell::Cmd::Arduino::Dbg, Cpl::TShell::Cmd::Bye, Cpl::TShell::Cmd::Help, Cpl::TShell::Cmd::Threads, Cpl::TShell::Cmd::Tick, Cpl::TShell::Cmd::TPrint, Cpl::TShell::Cmd::Trace, Cpl::TShell::Cmd::User, Cpl::TShell::Cmd::Wait, Driver::Crypto::TShell::Random, Driver::DIO::InOutCmd, Driver::NV::Cmd, Driver::RHTemp::TShellCmd, Driver::Wifi::Station::TShell::Wifi, Eros::TShell::HwSafety, Eros::TShell::Pwm, and Eros::TShell::Rgb.

getVerb()

virtual const char * Cpl::TShell::Command::getVerb ( ) const

pure virtualnoexcept

This method returns the command's verb string.

Implemented in Cpl::TShell::Cmd::Command.

---

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

• Cpl/TShell/Command.h