Bdb packages | Design docs | Source docs | Guidelines | Recent releases

Search | Site Map .
Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

AppOutputCommand Class Reference
[Framework]

#include <AppOutputCommand.hh>

Inheritance diagram for AppOutputCommand:

APPCommand AbsCommand AppFileOutputCommand BdbOutputCommand List of all members.

Public Methods

 AppOutputCommand (const char *const theCommand, AppModule *theTarget)
virtual ~AppOutputCommand ()
virtual int handle (int argc, char *argv[])
virtual void show () const
virtual bool isShowable () const
virtual void dumpState (AppConfigRecorder *)
virtual void restoreState (char *[])

Protected Methods

virtual int handleCommand (int argc, char *argv[])
virtual int createHandler ()
virtual int deleteHandler ()
virtual int destinationHandler ()
virtual int disableHandler ()
virtual int enableHandler ()
virtual int helpHandler ()
virtual int listHandler ()
virtual int pathsHandler ()
virtual int statisticsHandler ()
virtual int wipeoutHandler ()
virtual AppStream * createStream (const char *theName, const char *theDestination)=0
virtual const char * destinationString () const=0
virtual void listInformation (AppStream *theStream, AppFramework *theFrame)
virtual void statisticsInformation (AppStream *theStream, AppFramework *theFrame)

Private Methods

 AppOutputCommand (const AppOutputCommand &)
AppOutputCommand & operator= (const AppOutputCommand &)

Constructor & Destructor Documentation

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

Definition at line 69 of file AppOutputCommand.cc.

AppOutputCommand::~AppOutputCommand (    )  [virtual]
 

Definition at line 79 of file AppOutputCommand.cc.

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

Member Function Documentation

int AppOutputCommand::createHandler (    )  [protected, virtual]
 

Handler for the "create" command.

Reimplemented in BdbOutputCommand.

Definition at line 166 of file AppOutputCommand.cc.

References AppStreamsOutputModule::append(), createStream(), APPExecutable::framework(), APPCommand::getArgument(), AppStreamsOutputModule::has(), result, AppModule::setError(), APPCommand::target(), and APPCommand::validateName().

Referenced by handleCommand().

virtual AppStream* AppOutputCommand::createStream (  const char *    theName,
const char *    theDestination
)  [protected, pure virtual]
 

Create a concrete stream with the specified name and destination

Implemented in BdbOutputCommand, and AppFileOutputCommand.

Referenced by createHandler().

int AppOutputCommand::deleteHandler (    )  [protected, virtual]
 

Handler for the "delete" command.

Definition at line 198 of file AppOutputCommand.cc.

References AppStreamsOutputModule::fetch(), APPExecutable::framework(), APPCommand::getArgument(), AppStreamsOutputModule::remove(), result, AppModule::setError(), and APPCommand::target().

Referenced by handleCommand().

int AppOutputCommand::destinationHandler (    )  [protected, virtual]
 

Handler for the "destination" command.

Reimplemented in BdbOutputCommand.

Definition at line 230 of file AppOutputCommand.cc.

References AppStreamsOutputModule::fetch(), APPExecutable::framework(), APPCommand::getArgument(), result, AppStream::setDestination(), AppModule::setError(), APPCommand::target(), and APPCommand::validateName().

Referenced by handleCommand(), and AppFileOutputCommand::handleCommand().

virtual const char* AppOutputCommand::destinationString (    )  [protected, pure virtual]
 

Return a string to be used in describing the destination

Implemented in BdbOutputCommand, and AppFileOutputCommand.

Referenced by listHandler().

int AppOutputCommand::disableHandler (    )  [protected, virtual]
 

Handler for the "disable" command.

Definition at line 260 of file AppOutputCommand.cc.

References AppStreamsOutputModule::fetch(), APPExecutable::framework(), APPCommand::getArgument(), result, AppStream::setEnabled(), AppModule::setError(), and APPCommand::target().

Referenced by handleCommand().

void AppOutputCommand::dumpState (  AppConfigRecorder *    )  [virtual]
 

Implements APPCommand.

Reimplemented in BdbOutputCommand.

Definition at line 506 of file AppOutputCommand.cc.

References AppConfigRecorder::store(), AppStreamsOutputModule::streams(), and APPCommand::target().

int AppOutputCommand::enableHandler (    )  [protected, virtual]
 

Handler for the "enable" command.

Definition at line 292 of file AppOutputCommand.cc.

References AppStreamsOutputModule::fetch(), APPExecutable::framework(), APPCommand::getArgument(), result, AppStream::setEnabled(), AppModule::setError(), and APPCommand::target().

Referenced by handleCommand().

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

High level command handler required by the APPCommand interface. The function value denotes whether the command was a valid one or not.

Reimplemented from APPCommand.

Definition at line 88 of file AppOutputCommand.cc.

References handleCommand(), result, APPCommand::setArgs(), AppModule::setError(), and APPCommand::target().

Referenced by restoreState().

int AppOutputCommand::handleCommand (  int    argc,
char *    argv[]
)  [protected, virtual]
 

Low level command handler. The function value denotes whether the command was a valid one or not.

Reimplemented in BdbOutputCommand, and AppFileOutputCommand.

Definition at line 124 of file AppOutputCommand.cc.

References createHandler(), deleteHandler(), destinationHandler(), disableHandler(), enableHandler(), helpHandler(), listHandler(), pathsHandler(), result, statisticsHandler(), and wipeoutHandler().

Referenced by handle(), AppFileOutputCommand::handleCommand(), and BdbOutputCommand::handleCommand().

int AppOutputCommand::helpHandler (    )  [protected, virtual]
 

Handler for the "help" command.

Reimplemented in BdbOutputCommand, and AppFileOutputCommand.

Definition at line 323 of file AppOutputCommand.cc.

References APPExecutable::framework(), APPExecutable::fullReport(), APPExecutable::partialReport(), result, and APPCommand::target().

Referenced by handleCommand(), AppFileOutputCommand::helpHandler(), and BdbOutputCommand::helpHandler().

bool AppOutputCommand::isShowable (    )  [virtual]
 

Reimplemented from APPCommand.

Definition at line 115 of file AppOutputCommand.cc.

int AppOutputCommand::listHandler (    )  [protected, virtual]
 

Handler for the "list" command.

Definition at line 355 of file AppOutputCommand.cc.

References destinationString(), APPExecutable::framework(), APPExecutable::fullReport(), listInformation(), APPExecutable::partialReport(), AppStreamsOutputModule::streams(), and APPCommand::target().

Referenced by handleCommand().

void AppOutputCommand::listInformation (  AppStream *    theStream,
AppFramework *    theFrame
)  [protected, virtual]
 

Provide additional information to the "list" command. The default doesn't provide any addional information, but subclasses may choose to override this.

Reimplemented in BdbOutputCommand.

Definition at line 496 of file AppOutputCommand.cc.

Referenced by listHandler().

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

int AppOutputCommand::pathsHandler (    )  [protected, virtual]
 

Handler for the "paths" command.

Definition at line 406 of file AppOutputCommand.cc.

References AppStream::append(), AppStreamsOutputModule::fetch(), AppFramework::fetchPath(), APPExecutable::framework(), APPCommand::getArgument(), AppStream::remove(), result, AppModule::setError(), and APPCommand::target().

Referenced by handleCommand().

void AppOutputCommand::restoreState (  char *   [] )  [virtual]
 

Implements APPCommand.

Reimplemented in BdbOutputCommand.

Definition at line 549 of file AppOutputCommand.cc.

References handle().

Referenced by BdbOutputCommand::restoreState().

void AppOutputCommand::show (    )  [virtual]
 

Reimplemented from APPCommand.

Definition at line 111 of file AppOutputCommand.cc.

int AppOutputCommand::statisticsHandler (    )  [protected, virtual]
 

Handler for the "statistics" command.

Definition at line 459 of file AppOutputCommand.cc.

References APPExecutable::framework(), APPExecutable::fullReport(), APPExecutable::partialReport(), statisticsInformation(), AppStreamsOutputModule::streams(), and APPCommand::target().

Referenced by handleCommand().

void AppOutputCommand::statisticsInformation (  AppStream *    theStream,
AppFramework *    theFrame
)  [protected, virtual]
 

Provide additional information to the "statistics" command. The default implementation doesn't provide any addional information, but subclasses may choose to override this.

Definition at line 501 of file AppOutputCommand.cc.

Referenced by statisticsHandler().

int AppOutputCommand::wipeoutHandler (    )  [protected, virtual]
 

Handler for the "wipe-out" command.

Definition at line 489 of file AppOutputCommand.cc.

References APPCommand::target(), and AppStreamsOutputModule::wipeout().

Referenced by handleCommand().

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

 

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

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