Signature for a command handler.
More...
#include <CommandHandler.h>
|
virtual void | run (Print &printer, int argc, const char *const *argv) const =0 |
| Run the command. More...
|
|
ace_common::FCString | getName () const |
| Return the name of the command.
|
|
ace_common::FCString | getHelpString () const |
| Return the help string of the command.
|
|
|
static bool | isArgEqual (const char *arg, const char *token) |
| Test for equality against token.
|
|
static bool | isArgEqual (const char *arg, const __FlashStringHelper *token) |
| Test for equality when token is in PROGMEM.
|
|
Signature for a command handler.
Definition at line 46 of file CommandHandler.h.
◆ CommandHandler() [1/2]
cli::CommandHandler::CommandHandler |
( |
const char * |
name, |
|
|
const char * |
helpString |
|
) |
| |
|
inlineprotected |
◆ CommandHandler() [2/2]
cli::CommandHandler::CommandHandler |
( |
const __FlashStringHelper * |
name, |
|
|
const __FlashStringHelper * |
helpString |
|
) |
| |
|
inlineprotected |
◆ run()
virtual void cli::CommandHandler::run |
( |
Print & |
printer, |
|
|
int |
argc, |
|
|
const char *const * |
argv |
|
) |
| const |
|
pure virtual |
Run the command.
- Parameters
-
printer | The output printer, normally Serial. This is not expected to change during the lifetime of the CommandHandler instance, so normally I would inject this parameter into the object. However, that would cause each instance to consume 2 more bytes, even though all instances are expected to have the same 'printer'. For an 8-bit AVR processor with only 2kB of RAM, every byte is important , so I am keeping this as a parameter passed into the run() method. |
argc | Number of tokens in the input command, including the name of the command itself. |
argv | An array of strings for each token. |
The documentation for this class was generated from the following file: