Command Class Reference

#include <Command.h>

Collaboration diagram for Command:

Public Member Functions
	Command (const char *keyword, const char *description, bool advanced)
Command &	addSyntax (const char *syntaxHelp, void(*syntaxCall)(ParsedCommand *, int), const int mode=0)
Command &	addArg (CommandArg *arg)
Command &	addArg (const char *keyword, const RequiredType required=REQUIRED)
Command &	addArg (const CommandArgType argType, const RequiredType required=REQUIRED, const char *altName=NULL)
const char *	getKeyword ()
const int	getKeywordLen ()
CommandSyntax *	getSyntax (int index)
int	getSyntaxCount ()
void	help (bool full, FILE *out) const

Protected Attributes
FlexArray< CommandSyntax * >	syntaxes_
int	syntaxCount_
const char *	keyword_
const char *	description_
bool	advanced_
int	keywordLen_

Private Member Functions
	Command (const Command &old)

Constructor & Destructor Documentation

Command::Command ( const char *  keyword, const char *  description, bool  advanced  )

inline

Command::Command ( const Command &  old )

private

Member Function Documentation

Command& Command::addArg ( CommandArg *  arg )

inline

References CommandSyntax::addArg(), FlexArray< T >::peek(), and syntaxes_.

Referenced by addArg(), and CommandLine::CommandLine().

Command& Command::addArg ( const char *  keyword, const RequiredType  required = REQUIRED  )

inline

References addArg().

Command& Command::addArg ( const CommandArgType  argType, const RequiredType  required = REQUIRED, const char *  altName = NULL  )

inline

References addArg().

Command& Command::addSyntax ( const char *  syntaxHelp, void(*)(ParsedCommand *, int)  syntaxCall, const int  mode = 0  )

inline

References FlexArray< T >::push(), syntaxCount_, and syntaxes_.

Referenced by CommandLine::CommandLine().

const char* Command::getKeyword ( )

inline

References keyword_.

Referenced by CommandLine::completeArg(), ParsedCommand::completeCommand(), ParsedCommand::execute(), ParsedCommand::matchCommand(), CommandLine_Test::testParse(), and ParsedCommand::toString().

const int Command::getKeywordLen ( )

inline

References keywordLen_.

Referenced by CommandLine_Test::testParse().

CommandSyntax* Command::getSyntax ( int  index )

inline

References FlexArray< T >::get(), and syntaxes_.

Referenced by ParsedCommand::findArg(), ParsedCommand::implySyntax(), and CommandLine_Test::testParse().

int Command::getSyntaxCount ( )

inline

References syntaxCount_.

Referenced by ParsedCommand::findArg(), ParsedCommand::implySyntax(), and CommandLine_Test::testParse().

void Command::help ( bool  full, FILE *  out  ) const

inline

References description_, FlexArray< T >::get(), CommandSyntax::help(), keyword_, syntaxCount_, and syntaxes_.

Referenced by CommandLine::commandHelp().

Member Data Documentation

bool Command::advanced_

protected

const char* Command::description_

protected

Referenced by help().

const char* Command::keyword_

protected

Referenced by getKeyword(), and help().

int Command::keywordLen_

protected

Referenced by getKeywordLen().

int Command::syntaxCount_

protected

Referenced by addSyntax(), getSyntaxCount(), and help().

FlexArray<CommandSyntax*> Command::syntaxes_

protected

Referenced by addArg(), addSyntax(), getSyntax(), and help().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/supervisor/Command.h