Cpl::Dm::TShell::Dm Class Reference

This class implements a TShell command. More...

Detailed Description

This class implements a TShell command.

Note: Up to 10 different instance of this command can be instantiated - but each instance MUST have a different database number. The database number specified by specifying the actual command name, e.g. 'dm0' is database number 0, 'dm1' is database number 1, etc.

#include <Dm.h>

Inheritance diagram for Cpl::Dm::TShell::Dm:

Collaboration diagram for Cpl::Dm::TShell::Dm:

Public Member Functions
const char *	getUsage () const noexcept
	Dynamic.
const char *	getHelp () const noexcept
	See Cpl::TShell::Command.
	Dm (Cpl::Container::SList< Cpl::TShell::Command > &commandList, Cpl::Dm::ModelDatabaseApi &modelDatabase, const char *cmdNameAndDatabaseNumber="dm", Cpl::TShell::Security::Permission_T minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL) 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 *	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::Dm::ModelDatabaseApi &	m_database
	Model Point Database to access.
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

Dm()

Cpl::Dm::TShell::Dm::Dm ( Cpl::Container::SList< Cpl::TShell::Command > & commandList, Cpl::Dm::ModelDatabaseApi & modelDatabase, const char * cmdNameAndDatabaseNumber = "dm", Cpl::TShell::Security::Permission_T minPermLevel = OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL )

noexcept

Constructor.

Member Function Documentation

execute()

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

virtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getHelp()

const char * Cpl::Dm::TShell::Dm::getHelp ( ) const

inlinevirtualnoexcept

See Cpl::TShell::Command.

Implements Cpl::TShell::Command.

getUsage()

const char * Cpl::Dm::TShell::Dm::getUsage ( ) const

inlinevirtualnoexcept

Dynamic.

See Cpl::TShell::Command `

Implements Cpl::TShell::Command.

Member Data Documentation

detailedHelp

constexpr const char* Cpl::Dm::TShell::Dm::detailedHelp

staticconstexpr

Initial value:

= "  Lists, updates, and displays Model Points contained in the Model Database.\n" 
                                                "  When 'ls' is used a list of model point names is returned.  The <filter>\n" 
                                                "  argument will only list points that contain <filter>.  Updating a Model Point\n" 
                                                "  is done by specifying a JSON object. See the concrete class definition of the\n" 
                                                "  Model Point being updated for the JSON format.  When displaying a Model Point\n" 
                                                "  <mpname> is the string name of the Model Point instance to be displayed."

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

m_database

Cpl::Dm::ModelDatabaseApi& Cpl::Dm::TShell::Dm::m_database

protected

Model Point Database to access.

usage

constexpr const char* Cpl::Dm::TShell::Dm::usage

staticconstexpr

Initial value:

= "dm ls [<filter>]\n" 
                                         "dm write {<mp-json>}\n" 
                                         "dm read <mpname>\n" 
                                         "dm touch <mpname>"

The command usage string.

---

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

• Cpl/Dm/TShell/Dm.h