CommandProcessing::CommandDef Struct Reference

Command definition stored by handler. More...

#include <Command.h>

Inheritance diagram for CommandProcessing::CommandDef:

Collaboration diagram for CommandProcessing::CommandDef:

Public Types
using	Callback = Delegate< void(String commandLine, ReadWriteStream &commandOutput)>
	Command delegate function. More...

Public Member Functions
	operator bool () const
bool	operator== (const String &name) const
String	get (StringIndex index) const

Public Attributes
CStringArray	strings
Callback	callback

Detailed Description

Command definition stored by handler.

Member Typedef Documentation

Callback

using CommandProcessing::CommandDef::Callback = Delegate<void(String commandLine, ReadWriteStream& commandOutput)>

Command delegate function.

Parameters

commandLine	Command line entered by user at CLI, including command and parameters
commandOutput	Pointer to the CLI print stream

Note

CommandFunctionDelegate defines the structure of a function that handles individual commands

Can use standard print functions on commandOutput

Member Function Documentation

get()

String CommandProcessing::CommandDef::get ( StringIndex  index ) const

inline

operator bool()

CommandProcessing::CommandDef::operator bool ( ) const

inline

operator==()

bool CommandProcessing::CommandDef::operator== ( const String &  name ) const

inline

Member Data Documentation

callback

Callback CommandProcessing::CommandDef::callback

strings

CStringArray CommandProcessing::CommandDef::strings

---

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

• CommandProcessing/src/CommandProcessing/Command.h