DtSubCommandManager Class Reference

A specialized version of DtConsoleCommandManager which handles a set of sub commands from another console command manager. This class will register a command with a parent DtConsoleCommandManager when it is created, and then process the arguments from the parent with the local commands registered.

Inheritance diagram for DtSubCommandManager:

Classes
class	DtRunSubCommand

Public Member Functions
	DtSubCommandManager (const DtString &commandName, DtConsoleCommandManager *parentManager)
virtual	~DtSubCommandManager ()
Public Member Functions inherited from DtConsoleCommandManager
	DtConsoleCommandManager ()
virtual	~DtConsoleCommandManager ()
virtual void	addCommand (DtString commandString, DtConsoleCommand *command)
virtual void	removeCommand (DtString commandString)
virtual void	removeCommand (DtConsoleCommand *command)
virtual bool	runCommand (DtString consoleString)
virtual DtString	helpText (const DtString &parameters) const
virtual void	addAlias (DtString aliasString, DtConsoleCommand *command)
virtual void	addAlias (DtString aliasString, DtString commandString)

Protected Attributes
DtConsoleCommandManager *	myParentManager
DtRunSubCommand *	myCommand
Protected Attributes inherited from DtConsoleCommandManager
DtConsoleCommandMap	myCommandMap
DtConsoleCommandMap	myAliasMap
tbb::spin_rw_mutex	myMutex
DtHelpConsoleCommand *	myHelpCommand

Additional Inherited Members
Static Public Member Functions inherited from DtConsoleCommandManager
static void	cleanup ()
static DtConsoleCommandManager *	globalConsoleCommandManager ()
Public Attributes inherited from DtConsoleCommandManager
boost::signals2::signal< void()>	signal_globalCommandManagerToBeDestroyed
Protected Types inherited from DtConsoleCommandManager
typedef std::map< DtString, DtConsoleCommand * >	DtConsoleCommandMap
Protected Member Functions inherited from DtConsoleCommandManager
virtual void	removeReferencesFromMap (DtConsoleCommandMap &commandMap, DtConsoleCommand *command)
Static Protected Attributes inherited from DtConsoleCommandManager
static DtConsoleCommandManager *	theConsoleCommandManager

Constructor & Destructor Documentation

DtSubCommandManager::DtSubCommandManager	(	const DtString &	commandName,
		DtConsoleCommandManager *	parentManager
	)

Parameters

commandName

The name of the command that will invoke subcommands in this manager. This is basically the "sub-menu" name.

virtual DtSubCommandManager::~DtSubCommandManager ( )

virtual

Member Data Documentation

DtConsoleCommandManager* DtSubCommandManager::myParentManager

protected

DtRunSubCommand* DtSubCommandManager::myCommand

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/consoleCommandManager.h