Bdb packages | Design docs | Source docs | Guidelines | Recent releases
	Search | Site Map .

                 

---

APPCommand Class Reference
[Framework]

#include <APPCommand.hh>

Inheritance diagram for APPCommand:

List of all members.

Public Methods
	APPCommand ()
	APPCommand (const char *const theCommand, AppModule *theTarget)
virtual	~APPCommand ()
char *	command () const
virtual void	show () const
virtual bool	isShowable () const
virtual FwkString	description () const
AppModule *	target () const
bool	isEnabled () const
void	initialize (const char *const theCommand, AppModule *theTarget)
void	disable ()
void	enable ()
virtual int	handle (int argc, char *argv[])
virtual void	dumpState (AppConfigRecorder *)=0
virtual void	restoreState (char *[])=0
virtual void	initForRestore ()
Protected Methods
void	setEnabled (bool mode)
char *	getArgument (int index) const
APPNameNode *	getNameNode (int *index) const
bool	validateName (const char *const theName) const
void	setArgs (int argc, char *argv[])
bool	isValid ()
Protected Attributes
int	_argc
char **	_argv
Private Methods
	APPCommand (const APPCommand &)
APPCommand &	operator= (const APPCommand &)
Private Attributes
AppModule *	_target
char *	_command
bool	_enabled
bool	_isValid

---

Constructor & Destructor Documentation

APPCommand::APPCommand (    )

Definition at line 61 of file APPCommand.cc. References false.

APPCommand::APPCommand (  const char *const    theCommand, AppModule *    theTarget )

Definition at line 67 of file APPCommand.cc. References _command, _isValid, and false.

APPCommand::~APPCommand (    )  [virtual]

Definition at line 84 of file APPCommand.cc. References _command.

APPCommand::APPCommand (  const APPCommand &    )  [private]

---

Member Function Documentation

char * APPCommand::command (    )

Definition at line 105 of file APPCommand.cc. References _command. Referenced by APPMenu::description(), disable(), APPMenu::disableCommands(), enable(), APPMenu::enableCommands(), APPMenu::help(), and APPMenu::show().

virtual FwkString APPCommand::description (    )  const [inline, virtual]

Reimplemented in AbsParm, AppActionCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPMenu, APPModuleCommand, APPPathCommand, APPSequenceCommand, APPShowCommand, and AppSourceFileCommand. Definition at line 73 of file APPCommand.hh.

void APPCommand::disable (    )

Definition at line 141 of file APPCommand.cc. References command(), isEnabled(), and setEnabled().

virtual void APPCommand::dumpState (  AppConfigRecorder *    )  [pure virtual]

Implemented in BdbCollectionCommand, BdbOutputCommand, BdbSetTruncTime, BdbTreeNodeCommand, AbsParm, AbsParmBool, AbsParmDouble, AbsParmFilename, AbsParmGeneral< DefType >, AbsParmString, AppActionCommand, APPBasicCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPInputCommand, APPMenu, APPMenu::APPExitMenuCommand, APPMenu::APPHelpMenuCommand, APPMenu::APPShowMenuCommand, AppOutputCommand, APPShowCommand, AppSourceFileCommand, AbsParmGeneral< HepString >, and AbsParmGeneral< int >.

void APPCommand::enable (    )

Definition at line 152 of file APPCommand.cc. References command(), isEnabled(), and setEnabled().

char * APPCommand::getArgument (  int    index )  const [protected]

Definition at line 194 of file APPCommand.cc. References _argc, _argv, and result. Referenced by APPModuleCommand::accountHandler(), APPInputCommand::addHandler(), BdbInputCommand::addHandler(), APPSequenceCommand::appendHandler(), APPModuleCommand::cloneHandler(), APPSequenceCommand::createHandler(), AppOutputCommand::createHandler(), BdbOutputCommand::createHandler(), APPSequenceCommand::deleteHandler(), APPPathCommand::deleteHandler(), AppOutputCommand::deleteHandler(), AppOutputCommand::destinationHandler(), BdbOutputCommand::destinationHandler(), APPSequenceCommand::disableHandler(), AppOutputCommand::disableHandler(), APPModuleCommand::disableHandler(), AppActionCommand::disableHandler(), AppConfigCommand::dumpHandler(), APPSequenceCommand::enableHandler(), AppOutputCommand::enableHandler(), APPModuleCommand::enableHandler(), AppActionCommand::enableHandler(), APPModuleCommand::inputHandler(), APPSequenceCommand::insertHandler(), BdbOutputCommand::masterHandler(), APPModuleCommand::outputHandler(), AppOutputCommand::pathsHandler(), APPSequenceCommand::removeHandler(), APPInputCommand::removeHandler(), AbsParmString::setHandler(), AbsParmFilename::setHandler(), AbsParmDouble::setHandler(), AbsParmBool::setHandler(), BdbOutputCommand::setHandler(), and APPModuleCommand::talkToHandler().

APPNameNode * APPCommand::getNameNode (  int *    index )  const [protected]

Definition at line 205 of file APPCommand.cc. References _argc, _argv, result, AppModule::setError(), target(), and validateName(). Referenced by APPSequenceCommand::appendHandler(), APPSequenceCommand::createHandler(), APPSequenceCommand::insertHandler(), and APPSequenceCommand::removeHandler().

int APPCommand::handle (  int    argc, char *    argv[] )  [virtual]

Reimplemented in BdbCollectionCommand, BdbInputCommand, BdbSetTruncTime, BdbTreeNodeCommand, AbsParm, AppActionCommand, APPBasicCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPInputCommand, APPMenu, APPMenu::APPExitMenuCommand, APPMenu::APPHelpMenuCommand, APPMenu::APPShowMenuCommand, APPModuleCommand, AppOutputCommand, APPShowCommand, and AppSourceFileCommand. Definition at line 167 of file APPCommand.cc. References _command, APPExecutable::fullReport(), APPExecutable::partialReport(), and target().

virtual void APPCommand::initForRestore (    )  [inline, virtual]

Definition at line 87 of file APPCommand.hh.

void APPCommand::initialize (  const char *const    theCommand, AppModule *    theTarget )

Definition at line 90 of file APPCommand.cc. References _command, _isValid, and _target. Referenced by APPMenu::initialize().

bool APPCommand::isEnabled (    )

Definition at line 131 of file APPCommand.cc. References _enabled. Referenced by disable(), and enable().

virtual bool APPCommand::isShowable (    )  const [inline, virtual]

Reimplemented in BdbCollectionCommand, BdbSetTruncTime, BdbTreeNodeCommand, AbsParm, AppActionCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPInputCommand, APPMenu, APPMenu::APPExitMenuCommand, APPMenu::APPHelpMenuCommand, APPMenu::APPShowMenuCommand, APPModuleCommand, AppOutputCommand, APPPathCommand, APPSequenceCommand, APPShowCommand, and AppSourceFileCommand. Definition at line 71 of file APPCommand.hh.

bool APPCommand::isValid (    )  [protected]

Definition at line 179 of file APPCommand.cc. References _isValid. Referenced by APPMenu::~APPMenu().

APPCommand& APPCommand::operator= (  const APPCommand &    )  [private]

virtual void APPCommand::restoreState (  char *   [] )  [pure virtual]

Implemented in BdbCollectionCommand, BdbOutputCommand, BdbSetTruncTime, BdbTreeNodeCommand, AbsParm, AbsParmBool, AbsParmDouble, AbsParmFilename, AbsParmGeneral< DefType >, AbsParmString, AppActionCommand, APPBasicCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPInputCommand, APPMenu, APPMenu::APPExitMenuCommand, APPMenu::APPHelpMenuCommand, APPMenu::APPShowMenuCommand, AppOutputCommand, APPShowCommand, AppSourceFileCommand, AbsParmGeneral< HepString >, and AbsParmGeneral< int >.

void APPCommand::setArgs (  int    argc, char *    argv[] )  [protected]

Definition at line 245 of file APPCommand.cc. References _argc, and _argv. Referenced by AppConfigCommand::dumpHandler(), AppOutputCommand::handle(), APPInputCommand::handle(), AppConfigCommand::handle(), APPBasicCommand::handle(), AppActionCommand::handle(), AbsParm::handle(), BdbTreeNodeCommand::handle(), BdbSetTruncTime::handle(), BdbInputCommand::handle(), BdbCollectionCommand::handle(), AppConfigCommand::restoreHandler(), AbsParmString::restoreState(), AbsParmFilename::restoreState(), AbsParmDouble::restoreState(), and AbsParmBool::restoreState().

void APPCommand::setEnabled (  bool    mode )  [protected]

Definition at line 185 of file APPCommand.cc. References _enabled. Referenced by disable(), and enable().

virtual void APPCommand::show (    )  const [inline, virtual]

Reimplemented in BdbCollectionCommand, BdbSetTruncTime, BdbTreeNodeCommand, AbsParm, AppActionCommand, AppConfigCommand, APPEchoCommand, APPEventsCommand, APPExitCommand, APPHelpCommand, APPInputCommand, APPMenu, APPMenu::APPExitMenuCommand, APPMenu::APPHelpMenuCommand, APPMenu::APPShowMenuCommand, APPModuleCommand, AppOutputCommand, APPPathCommand, APPSequenceCommand, APPShowCommand, and AppSourceFileCommand. Definition at line 67 of file APPCommand.hh.

AppModule * APPCommand::target (    )

Definition at line 118 of file APPCommand.cc. References _target. Referenced by APPModuleCommand::accountHandler(), APPBasicCommand::accountHandler(), APPInputCommand::addHandler(), BdbInputCommand::addHandler(), BdbCollectionCommand::addHandler(), APPSequenceCommand::appendHandler(), APPBasicCommand::appendHandler(), APPEventsCommand::beginConfigDump(), APPEventsCommand::beginHandler(), APPModuleCommand::cloneHandler(), APPBasicCommand::cloneHandler(), BdbCollectionCommand::contentsCollHandler(), BdbCollectionCommand::contentsHandler(), APPEventsCommand::continueHandler(), BdbCollectionCommand::createCollections(), APPSequenceCommand::createHandler(), AppOutputCommand::createHandler(), APPBasicCommand::createHandler(), BdbTreeNodeCommand::createHandler(), BdbOutputCommand::createHandler(), BdbCollectionCommand::createHandler(), BdbOutputCommand::createStream(), APPSequenceCommand::deleteHandler(), APPPathCommand::deleteHandler(), AppOutputCommand::deleteHandler(), APPBasicCommand::deleteHandler(), BdbTreeNodeCommand::deleteHandler(), BdbCollectionCommand::deleteHandler(), AppOutputCommand::destinationHandler(), BdbOutputCommand::destinationHandler(), APPSequenceCommand::disableHandler(), AppOutputCommand::disableHandler(), APPModuleCommand::disableHandler(), APPBasicCommand::disableHandler(), AppActionCommand::disableHandler(), AppConfigCommand::dumpHandler(), APPEventsCommand::dumpOnBeginHandler(), AppOutputCommand::dumpState(), APPInputCommand::dumpState(), BdbOutputCommand::dumpState(), APPMenu::enableCommands(), APPSequenceCommand::enableHandler(), AppOutputCommand::enableHandler(), APPModuleCommand::enableHandler(), APPBasicCommand::enableHandler(), AppActionCommand::enableHandler(), BdbCollectionCommand::eventsHandler(), APPMenu::exit(), getNameNode(), AppSourceFileCommand::handle(), AppOutputCommand::handle(), APPModuleCommand::handle(), APPMenu::handle(), APPInputCommand::handle(), APPEventsCommand::handle(), APPEchoCommand::handle(), AppConfigCommand::handle(), handle(), APPBasicCommand::handle(), AppActionCommand::handle(), AbsParm::handle(), BdbTreeNodeCommand::handle(), BdbSetTruncTime::handle(), BdbInputCommand::handle(), BdbCollectionCommand::handle(), APPSequenceCommand::helpHandler(), APPPathCommand::helpHandler(), AppOutputCommand::helpHandler(), APPModuleCommand::helpHandler(), AppFileOutputCommand::helpHandler(), APPEventsCommand::helpHandler(), AppConfigCommand::helpHandler(), APPBasicCommand::helpHandler(), AppActionCommand::helpHandler(), BdbTreeNodeCommand::helpHandler(), BdbSetTruncTime::helpHandler(), BdbOutputCommand::helpHandler(), BdbCollectionCommand::helpHandler(), APPModuleCommand::inputHandler(), APPBasicCommand::inputHandler(), APPSequenceCommand::insertHandler(), APPBasicCommand::insertHandler(), BdbTreeNodeCommand::listAllHandler(), BdbCollectionCommand::listAllHandler(), APPSequenceCommand::listHandler(), AppOutputCommand::listHandler(), APPModuleCommand::listHandler(), APPInputCommand::listHandler(), APPBasicCommand::listHandler(), AppActionCommand::listHandler(), AbsParmString::listHandler(), AbsParmFilename::listHandler(), AbsParmDouble::listHandler(), AbsParmBool::listHandler(), BdbTreeNodeCommand::listHandler(), BdbCollectionCommand::listHandler(), BdbTreeNodeCommand::listLevelHandler(), BdbCollectionCommand::listLevelHandler(), BdbTreeNodeCommand::listNodeHandler(), BdbCollectionCommand::listNodeHandler(), BdbCollectionCommand::mapHandler(), BdbOutputCommand::masterHandler(), BdbTreeNodeCommand::moveHandler(), BdbCollectionCommand::moveHandler(), APPModuleCommand::outputHandler(), APPBasicCommand::outputHandler(), AppOutputCommand::pathsHandler(), BdbCollectionCommand::precreateCleanupHandler(), APPSequenceCommand::removeHandler(), APPInputCommand::removeHandler(), APPBasicCommand::removeHandler(), BdbCollectionCommand::removeHandler(), AppConfigCommand::restoreHandler(), AbsParmString::setHandler(), AbsParmFilename::setHandler(), AbsParmDouble::setHandler(), AbsParmBool::setHandler(), BdbOutputCommand::setHandler(), AppOutputCommand::statisticsHandler(), APPModuleCommand::talkToHandler(), APPBasicCommand::talkToHandler(), AppOutputCommand::wipeoutHandler(), and APPInputCommand::wipeoutHandler().

bool APPCommand::validateName (  const char *const    theName )  const [protected]

Definition at line 236 of file APPCommand.cc. References result. Referenced by AppOutputCommand::createHandler(), BdbOutputCommand::createHandler(), AppOutputCommand::destinationHandler(), BdbOutputCommand::destinationHandler(), getNameNode(), and BdbOutputCommand::masterHandler().

---

Member Data Documentation

int APPCommand::_argc [protected]

Definition at line 105 of file APPCommand.hh. Referenced by APPInputCommand::addHandler(), BdbInputCommand::addHandler(), getArgument(), getNameNode(), setArgs(), AbsParmString::setHandler(), AbsParmFilename::setHandler(), AbsParmDouble::setHandler(), and AbsParmBool::setHandler().

char** APPCommand::_argv [protected]

Definition at line 106 of file APPCommand.hh. Referenced by getArgument(), getNameNode(), and setArgs().

char* APPCommand::_command [private]

Definition at line 115 of file APPCommand.hh. Referenced by APPCommand(), command(), handle(), initialize(), and ~APPCommand().

bool APPCommand::_enabled [private]

Definition at line 116 of file APPCommand.hh. Referenced by isEnabled(), and setEnabled().

bool APPCommand::_isValid [private]

Definition at line 117 of file APPCommand.hh. Referenced by APPCommand(), initialize(), and isValid().

AppModule* APPCommand::_target [private]

Definition at line 114 of file APPCommand.hh. Referenced by initialize(), and target().

---

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

• /Framework/Framework/APPCommand.hh
• /Framework/src/APPCommand.cc

 

---

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002