CommandProcessing::Command Class Reference

Command delegate class. More...

#include <Command.h>

Inheritance diagram for CommandProcessing::Command:
Collaboration diagram for CommandProcessing::Command:

Classes

struct  StringAccessor
 Helper class for accessing individual strings. More...
 

Public Member Functions

 Command (const String &name, const String &help, const String &group, Callback callback)
 
 Command (const CommandDef &def)
 

Public Attributes

const StringAccessor< StringIndex::name > name
 
const StringAccessor< StringIndex::help > help
 
const StringAccessor< StringIndex::group > group
 

Friends

class Handler
 

Detailed Description

Command delegate class.

Constructor & Destructor Documentation

◆ Command() [1/2]

CommandProcessing::Command::Command ( const String name,
const String help,
const String group,
Callback  callback 
)
inline

Instantiate a command delegate using set of wiring Strings

Parameters
nameCommand name - the text a user types to invoke the command
helpHelp message shown by CLI "help" command
groupThe command group to which this command belongs
callbackDelegate that should be invoked (triggered) when the command is entered by a user

◆ Command() [2/2]

CommandProcessing::Command::Command ( const CommandDef def)
inline

Friends And Related Function Documentation

◆ Handler

friend class Handler
friend

Member Data Documentation

◆ group

const StringAccessor<StringIndex::group> CommandProcessing::Command::group

◆ help

const StringAccessor<StringIndex::help> CommandProcessing::Command::help

◆ name

const StringAccessor<StringIndex::name> CommandProcessing::Command::name

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