CommandModule< PREFIX, SECTION > Class Template Reference

Combines command installation and sectioning. More...

#include <CommandInstaller.h>

Inheritance diagram for CommandModule< PREFIX, SECTION >:

Collaboration diagram for CommandModule< PREFIX, SECTION >:

Public Types
typedef CommandModule< PREFIX, SECTION >	module_t

Public Member Functions
	CommandModule (CommandBank &bank=getCommandBank())
template<class CMD , class CMD_NEW = CMD>
Command &	installDeprecating (const std::string &name, char alias=0)
	Mark deprecating commands by installing them with this.
template<class CMD , class CMD_NEW = CMD>
Command &	installDeprecating (char alias=0)
	Mark deprecating commands by installing them with this.
template<class ... TT>
void	linkRelatedCommands (TT &... cmds)
template<class ... TT>
void	linkRelatedCommandList (std::set< std::string > &cmdList, Command &cmd, TT &... cmds)
template<class ... TT>
void	linkRelatedCommandList (std::set< std::string > &cmdList, const std::string &cmdName, TT &... cmds)
template<class ... TT>
void	linkRelatedCommandList (std::set< std::string > &cmdList)
void	linkRelatedSection (Command &cmd, const CommandSection &section)

Additional Inherited Members
Protected Member Functions inherited from CommandInstaller< PREFIX, SECTION >
	CommandInstaller (CommandBank &bank=getCommandBank())
template<class CMD >
Command &	install (const std::string &name, char alias=0)
	Install command initialized and stored by command bank.
template<class CMD >
Command &	install (char alias=0)
	Install external command.
template<class CMD >
Command &	install (CMD &cmdExt, const std::string &name, char alias=0)
	Install external command.
template<class CMD >
Command &	install (CMD &cmdExt, char alias=0)
	Install external command.
Static Protected Member Functions inherited from CommandInstaller< PREFIX, SECTION >
static const CommandSection &	getSection ()
static char	getPrefix ()
	Return the character used as prefix for the commands in this section.
template<class CMD >
static Command &	installShared (const std::string &name, char alias=0)
	Install to shared (global) CommandBank.
template<class CMD >
static Command &	installShared (char alias=0)
	Install to shared (global) CommandBank.
Protected Attributes inherited from CommandInstaller< PREFIX, SECTION >
CommandBank &	cmdBank

Detailed Description

template<char PREFIX = 0, class SECTION = GeneralSection>
class drain::CommandModule< PREFIX, SECTION >

Combines command installation and sectioning.

Parameters

prefix	- 'c'
name	- "cart"

Constructor & Destructor Documentation

CommandModule()

template<char PREFIX = 0, class SECTION = GeneralSection>

CommandModule ( CommandBank &  bank = getCommandBank() )

inline

Parameters

prefix	- 'c'
name	- "cart"

Member Function Documentation

installDeprecating() [1/2]

template<char PREFIX = 0, class SECTION = GeneralSection>

template<class CMD , class CMD_NEW = CMD>

Command & installDeprecating ( char  alias = 0 )

inline

Mark deprecating commands by installing them with this.

If CMD_NEW is given (ie. different from CMD), add it to recommended alternatives.

installDeprecating() [2/2]

template<char PREFIX = 0, class SECTION = GeneralSection>

template<class CMD , class CMD_NEW = CMD>

Command & installDeprecating ( const std::string &  name, char  alias = 0  )

inline

Mark deprecating commands by installing them with this.

If CMD_NEW is given (ie. different from CMD), add it to recommended alternatives.

linkRelatedCommands()

template<char PREFIX = 0, class SECTION = GeneralSection>

template<class ... TT>

void linkRelatedCommands ( TT &...  cmds )

inline

Not static, because cmdBank addressed.

linkRelatedSection()

template<char PREFIX = 0, class SECTION = GeneralSection>

void linkRelatedSection ( Command &  cmd, const CommandSection &  section  )

inline

Command parameter is used only for referring to the static command provided by CommandBank.

---

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

• src/drain/prog/CommandInstaller.h