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  

AppModule Class Reference

#include <APPModule.hh>

Inheritance diagram for AppModule:

APPExecutable AppAccountModule APPFilterModule APPInputModule APPNoCloneModule APPOutputModule BdbAbsLoad BdbCreateCM BdbEventCommit BdbEventMerge BdbEventUpdate BdbInspector BdbSetRevision BdbSetTime BdbTransactionMgr CdbBdbInit DumpG3 DumpScribeChk FakeEventID FakeScribeChk TagCreateEmpty TagCreateEventId TagCreateModule TagDump TagFillExample TagInspector TagPlots List of all members.

Public Methods

 AppModule (const char *const theName, const char *const theDescription)
virtual ~AppModule ()
virtual AppResult beginJob (AbsEvent *anEvent)
virtual AppResult beginRun (AbsEvent *anEvent)
virtual AppResult event (AbsEvent *anEvent)
virtual AppResult other (AbsEvent *anEvent)
virtual AppResult frame (AppFrame *aFrame, const AppStopType &theDispatchStopType)
virtual AppResult endRun (AbsEvent *anEvent)
virtual AppResult endJob (AbsEvent *anEvent)
virtual AppResult abortJob (AbsEvent *anEvent)
void talkTo ()
virtual void help (int argc, char **argv)
void help ()
void show ()
virtual void show (int argc, char **argv) const
virtual bool isShowable () const
virtual void exit ()
virtual AppModule * clone (const char *cloneName)
virtual void menuHandler (char *menu, char *command, int argc, char **argv)
void disableCommands ()
void enableCommands ()
bool isInitialized () const
char * prompt () const
APPList< APPCommand * > * commands () const
virtual bool passed () const
char * menuFileName () const
void setError (const char *const theError)
void setInitialized ()
void setPrompt (const char *const thePrompt)
void setMenuFileName (const char *const filename)
bool verbose () const
bool production () const
void bindMethodToState (const AppStopType &aStopType, const AppMethodBase *const aMethod)
APPHash< AppMethodBase > * dynamicDispatchMap ()

Protected Attributes

APPHash< AppMethodBase > * _theDynamicDispatchMap
APPEchoCommand _echo
APPExitCommand _exit
APPHelpCommand _help
APPShowCommand _show
AppSourceFileCommand _sourceFileCmd
AbsParmBool _verbose
AbsParmBool _production
AbsParmBool _enableFrames

Static Protected Attributes

APPMenu moduleMenu
AbsEvent * _theAbsEvent = 0

Private Methods

 AppModule (const AppModule &)
AppModule & operator= (const AppModule &)

Private Attributes

APPList< APPCommand * > * _commands
bool _isInitialized
char * _prompt
char * _error
int _errorLen
char * _menuFileName

Friends

class APPMenu

Constructor & Destructor Documentation

AppModule::AppModule (  const char *const    theName,
const char *const    theDescription
) 
 

Definition at line 98 of file APPModule.cc.

References _commands, _echo, _enableFrames, APPExecutable::_execType, _exit, _help, _isInitialized, _production, _prompt, _show, _sourceFileCmd, _theDynamicDispatchMap, _verbose, APPExecutable::APP_module, false, and show().

AppModule::~AppModule (    )  [virtual]
 

Definition at line 143 of file APPModule.cc.

References _commands, _error, _menuFileName, _prompt, and _theDynamicDispatchMap.

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

Member Function Documentation

AppResult AppModule::abortJob (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in AppFramework, and AppStreamsOutputModule.

Definition at line 226 of file APPModule.cc.

References AppResult::OK.

Referenced by AppFramework::abortJob().

AppResult AppModule::beginJob (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in BdbEventInput, BdbEventOutput, BdbSetRevision, BdbSetTime, BdbTransactionMgr, CdbBdbInit, ScribeChkBdbLoad, AppFramework, AppStreamsOutputModule, TagBdbLoad, TagCreateModule, TagFastFilterByName, TagFastFilterExample, TagFillExample, TagFilterByName, TagFilterExample, TagFilterInputByName, TagFilterModule, TagInspector, and TagPlots.

Definition at line 167 of file APPModule.cc.

References AppResult::OK.

Referenced by AppActionApplicator::beginJob().

AppResult AppModule::beginRun (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in BdbEventInput, BdbEventMerge, BdbEventOutput, BdbTransactionMgr, AppFramework, AppStreamsOutputModule, TagBdbLoad, TagCreateModule, TagFastFilterExample, TagFillExample, TagFilterExample, and TagFilterModule.

Definition at line 172 of file APPModule.cc.

References AppResult::OK.

Referenced by AppFramework::beginJob(), and AppActionApplicator::beginRun().

void AppModule::bindMethodToState (  const AppStopType &    aStopType,
const AppMethodBase *const    aMethod
) 
 

Definition at line 475 of file APPModule.cc.

References _theDynamicDispatchMap, APPHash< AppMethodBase >::add(), APPExecutable::fullReport(), AppStopType::getStopTypeKey(), APPExecutable::name(), and APPExecutable::partialReport().

AppModule * AppModule::clone (  const char *    cloneName )  [virtual]
 

Reimplemented in TagFastFilterByName, and TagFilterByName.

Definition at line 321 of file APPModule.cc.

References APPExecutable::partialReport().

APPList< APPCommand * > * AppModule::commands (    ) 
 

Definition at line 399 of file APPModule.cc.

References _commands.

Referenced by AppFileOutputModule::AppFileOutputModule(), AppModuleMemento::AppModuleMemento(), BdbAbsLoad::BdbAbsLoad(), BdbCreateCM::BdbCreateCM(), BdbEventInput::BdbEventInput(), BdbEventMerge::BdbEventMerge(), BdbEventOutput::BdbEventOutput(), BdbEventUpdate::BdbEventUpdate(), BdbInspector::BdbInspector(), BdbSetRevision::BdbSetRevision(), BdbSetTime::BdbSetTime(), BdbSimpleFilter::BdbSimpleFilter(), BdbTransactionMgr::BdbTransactionMgr(), CdbBdbInit::CdbBdbInit(), disableCommands(), DumpG3::DumpG3(), DumpScribeChk::DumpScribeChk(), enableCommands(), FakeEventID::FakeEventID(), FakeScribeChk::FakeScribeChk(), help(), AppMemento::restoreStates(), ScribeChkBdbLoad::ScribeChkBdbLoad(), show(), AppFramework::show(), TagBdbLoad::TagBdbLoad(), TagCreateEventId::TagCreateEventId(), TagDump::TagDump(), TagFastFilterByName::TagFastFilterByName(), TagFillExample::TagFillExample(), TagFilterByName::TagFilterByName(), TagFilterInputByName::TagFilterInputByName(), TagFilterInputExample::TagFilterInputExample(), TagFilterInputModule::TagFilterInputModule(), TagInspector::TagInspector(), and TagPlots::TagPlots().

void AppModule::disableCommands (    ) 
 

Definition at line 372 of file APPModule.cc.

References commands().

Referenced by exit(), APPMenu::handle(), AppFramework::setupTheApp(), AppFramework::talkTo(), and APPModuleCommand::talkToHandler().

APPHash< AppMethodBase > * AppModule::dynamicDispatchMap (    ) 
 

Definition at line 493 of file APPModule.cc.

References _theDynamicDispatchMap.

void AppModule::enableCommands (    ) 
 

Definition at line 382 of file APPModule.cc.

References commands(), and prompt().

Referenced by exit(), APPMenu::exit(), AppFramework::setupTheApp(), talkTo(), and AppFramework::talkTo().

AppResult AppModule::endJob (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in BdbCreateCM, BdbEventInput, BdbEventOutput, BdbTransactionMgr, AppFramework, AppStreamsOutputModule, TagFastFilterByName, TagFilterByName, TagFilterInputModule, and TagInspector.

Definition at line 221 of file APPModule.cc.

References AppResult::OK.

Referenced by AppActionApplicator::endJob().

AppResult AppModule::endRun (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in AppFramework, and AppStreamsOutputModule.

Definition at line 216 of file APPModule.cc.

References AppResult::OK.

Referenced by AppActionApplicator::endRun().

AppResult AppModule::event (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in BdbAbsLoad, BdbCreateCM, BdbEventCommit, BdbEventMerge, BdbEventUpdate, BdbSetTime, BdbSimpleFilter, BdbTransactionMgr, DumpG3, DumpScribeChk, FakeEventID, FakeScribeChk, PassEverything, PassOddCount, AppFramework, TagCreateEmpty, TagCreateEventId, TagCreateModule, TagDump, TagFastFilterByName, TagFastFilterExample, TagFillExample, TagFilterByName, TagFilterExample, TagFilterModule, TagInspector, and TagPlots.

Definition at line 204 of file APPModule.cc.

References AppResult::OK.

Referenced by AppActionApplicator::event().

void AppModule::exit (    )  [virtual]
 

Reimplemented in AppFramework.

Definition at line 365 of file APPModule.cc.

References disableCommands(), enableCommands(), and APPExecutable::framework().

AppResult AppModule::frame (  AppFrame *    aFrame,
const AppStopType &    theDispatchStopType
)  [virtual]
 

Implements APPExecutable.

Reimplemented in AppFramework.

Definition at line 178 of file APPModule.cc.

References _theDynamicDispatchMap, AppMethodBase::execute(), APPHash< AppMethodBase >::fetch(), APPExecutable::fullReport(), AppStopType::getStopTypeKey(), APPHash< AppMethodBase >::has(), AppResult::OK, and AppResult::value().

void AppModule::help (    ) 
 

Definition at line 239 of file APPModule.cc.

Referenced by TagInspector::help(), TagFilterModule::help(), TagFilterExample::help(), TagFilterByName::help(), TagFillExample::help(), TagFastFilterModule::help(), TagFastFilterExample::help(), TagFastFilterByName::help(), TagCreateModule::help(), TagCreateEventId::help(), TagCreateEmpty::help(), TagBdbLoad::help(), AppStreamsOutputModule::help(), AppFramework::help(), PassOddCount::help(), PassEverything::help(), BdbTransactionMgr::help(), BdbSimpleFilter::help(), BdbInspector::help(), BdbEventUpdate::help(), BdbEventOutput::help(), BdbEventMerge::help(), BdbEventInput::help(), and BdbEventCommit::help().

void AppModule::help (  int    argc,
char **    argv
)  [virtual]
 

Reimplemented in BdbEventCommit, BdbEventInput, BdbEventMerge, BdbEventOutput, BdbEventUpdate, BdbInspector, BdbSimpleFilter, BdbTransactionMgr, PassEverything, PassOddCount, AppFramework, AppStreamsOutputModule, TagBdbLoad, TagCreateEmpty, TagCreateEventId, TagCreateModule, TagFastFilterByName, TagFastFilterExample, TagFastFilterModule, TagFillExample, TagFilterByName, TagFilterExample, TagFilterModule, and TagInspector.

Definition at line 249 of file APPModule.cc.

References commands(), APPExecutable::fullReport(), APPExecutable::name(), and APPExecutable::partialReport().

bool AppModule::isInitialized (    ) 
 

Definition at line 405 of file APPModule.cc.

References _isInitialized.

Referenced by AppFramework::setAccountModule(), AppFramework::setInputModule(), and AppFramework::setOutputModule().

bool AppModule::isShowable (    )  [virtual]
 

Definition at line 343 of file APPModule.cc.

char * AppModule::menuFileName (    ) 
 

Definition at line 423 of file APPModule.cc.

References _menuFileName.

void AppModule::menuHandler (  char *    menu,
char *    command,
int    argc,
char **    argv
)  [virtual]
 

Definition at line 348 of file APPModule.cc.

References APPExecutable::fullReport(), and APPExecutable::partialReport().

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

AppResult AppModule::other (  AbsEvent *    anEvent )  [virtual]
 

Implements APPExecutable.

Reimplemented in AppFramework.

Definition at line 210 of file APPModule.cc.

References AppResult::OK.

Referenced by BdbEventInput::append(), BdbAbsLoad::operator==(), and AppActionApplicator::other().

bool AppModule::passed (    )  [virtual]
 

Reimplemented from APPExecutable.

Reimplemented in APPFilterModule.

Definition at line 411 of file APPModule.cc.

Referenced by TagInspector::event(), and TagFilterInputModule::trySelectEvent().

bool AppModule::production (    ) 
 

Definition at line 337 of file APPModule.cc.

References _production, and AbsParmBool::value().

char * AppModule::prompt (    ) 
 

Definition at line 417 of file APPModule.cc.

References _prompt.

Referenced by enableCommands(), and printAllAbsParm().

void AppModule::setError (  const char *const    theError ) 
 

Definition at line 432 of file APPModule.cc.

References _error, and _errorLen.

Referenced by APPModuleCommand::accountHandler(), APPBasicCommand::accountHandler(), BdbCollectionCommand::addHandler(), APPSequenceCommand::appendHandler(), APPBasicCommand::appendHandler(), APPEventsCommand::beginHandler(), APPModuleCommand::cloneHandler(), APPBasicCommand::cloneHandler(), BdbCollectionCommand::contentsHandler(), APPEventsCommand::continueHandler(), BdbCollectionCommand::createCollections(), APPSequenceCommand::createHandler(), AppOutputCommand::createHandler(), APPBasicCommand::createHandler(), BdbOutputCommand::createHandler(), BdbCollectionCommand::createHandler(), APPSequenceCommand::deleteHandler(), APPPathCommand::deleteHandler(), AppOutputCommand::deleteHandler(), APPBasicCommand::deleteHandler(), AppOutputCommand::destinationHandler(), BdbOutputCommand::destinationHandler(), APPSequenceCommand::disableHandler(), AppOutputCommand::disableHandler(), APPModuleCommand::disableHandler(), APPBasicCommand::disableHandler(), APPEventsCommand::dumpOnBeginHandler(), APPSequenceCommand::enableHandler(), AppOutputCommand::enableHandler(), APPModuleCommand::enableHandler(), APPBasicCommand::enableHandler(), BdbCollectionCommand::eventsHandler(), APPCommand::getNameNode(), AppSourceFileCommand::handle(), AppOutputCommand::handle(), APPModuleCommand::handle(), APPInputCommand::handle(), APPEventsCommand::handle(), AppConfigCommand::handle(), APPBasicCommand::handle(), AppActionCommand::handle(), AbsParm::handle(), BdbTreeNodeCommand::handle(), BdbSetTruncTime::handle(), BdbInputCommand::handle(), BdbCollectionCommand::handle(), APPModuleCommand::inputHandler(), APPBasicCommand::inputHandler(), APPSequenceCommand::insertHandler(), APPBasicCommand::insertHandler(), APPBasicCommand::listHandler(), BdbTreeNodeCommand::listHandler(), BdbCollectionCommand::listHandler(), BdbCollectionCommand::mapHandler(), BdbOutputCommand::masterHandler(), BdbTreeNodeCommand::moveHandler(), BdbCollectionCommand::moveHandler(), APPModuleCommand::outputHandler(), APPBasicCommand::outputHandler(), AppOutputCommand::pathsHandler(), BdbCollectionCommand::precreateCleanupHandler(), APPSequenceCommand::removeHandler(), APPBasicCommand::removeHandler(), BdbCollectionCommand::removeHandler(), BdbOutputCommand::setHandler(), APPModuleCommand::talkToHandler(), and APPBasicCommand::talkToHandler().

void AppModule::setInitialized (    ) 
 

Definition at line 455 of file APPModule.cc.

References _isInitialized.

void AppModule::setMenuFileName (  const char *const    filename ) 
 

Definition at line 497 of file APPModule.cc.

References _menuFileName.

void AppModule::setPrompt (  const char *const    thePrompt ) 
 

Definition at line 461 of file APPModule.cc.

References _prompt.

void AppModule::show (  int    argc,
char **    argv
)  const [virtual]
 

Reimplemented in AppFramework.

Definition at line 289 of file APPModule.cc.

References commands(), APPExecutable::fullReport(), APPExecutable::name(), and APPExecutable::partialReport().

void AppModule::show (    ) 
 

Definition at line 243 of file APPModule.cc.

void AppModule::talkTo (    ) 
 

Reimplemented in AppFramework.

Definition at line 231 of file APPModule.cc.

References enableCommands().

Referenced by APPModuleCommand::talkToHandler().

bool AppModule::verbose (    ) 
 

Definition at line 331 of file APPModule.cc.

References _verbose, and AbsParmBool::value().

Referenced by AppFramework::add(), APPListDeleteAll(), BdbSetRevision::beginJob(), TagCreateEventId::event(), and BdbSimpleFilter::event().

Friends And Related Function Documentation

friend class APPMenu [friend]
 

Definition at line 224 of file APPModule.hh.

Member Data Documentation

APPList< APPCommand* >* AppModule::_commands [private]
 

Definition at line 186 of file APPModule.hh.

Referenced by AppModule(), commands(), and ~AppModule().

APPEchoCommand AppModule::_echo [protected]
 

Definition at line 211 of file APPModule.hh.

Referenced by AppModule().

AbsParmBool AppModule::_enableFrames [protected]
 

Definition at line 222 of file APPModule.hh.

Referenced by AppModule(), and AppFramework::continueHandler().

char* AppModule::_error [private]
 

Definition at line 189 of file APPModule.hh.

Referenced by setError(), and ~AppModule().

int AppModule::_errorLen [private]
 

Definition at line 190 of file APPModule.hh.

Referenced by setError().

APPExitCommand AppModule::_exit [protected]
 

Definition at line 212 of file APPModule.hh.

Referenced by AppModule().

APPHelpCommand AppModule::_help [protected]
 

Definition at line 213 of file APPModule.hh.

Referenced by AppModule().

bool AppModule::_isInitialized [private]
 

Definition at line 187 of file APPModule.hh.

Referenced by AppModule(), isInitialized(), and setInitialized().

char* AppModule::_menuFileName [private]
 

Definition at line 192 of file APPModule.hh.

Referenced by menuFileName(), setMenuFileName(), and ~AppModule().

AbsParmBool AppModule::_production [protected]
 

Definition at line 220 of file APPModule.hh.

Referenced by AppModule(), and production().

char* AppModule::_prompt [private]
 

Definition at line 188 of file APPModule.hh.

Referenced by AppModule(), prompt(), setPrompt(), and ~AppModule().

APPShowCommand AppModule::_show [protected]
 

Definition at line 214 of file APPModule.hh.

Referenced by AppModule().

AppSourceFileCommand AppModule::_sourceFileCmd [protected]
 

Definition at line 215 of file APPModule.hh.

Referenced by AppModule().

AbsEvent * AppModule::_theAbsEvent = 0 [static, protected]
 

Definition at line 88 of file APPModule.cc.

Referenced by AppFramework::beginHandler(), AppFramework::continueHandler(), APPInputModule::inputEvent(), BdbEventInput::inputEvent(), AppFramework::theEvent(), and AppFramework::zeroTheEvent().

APPHash< AppMethodBase >* AppModule::_theDynamicDispatchMap [protected]
 

Definition at line 176 of file APPModule.hh.

Referenced by AppModule(), bindMethodToState(), dynamicDispatchMap(), frame(), and ~AppModule().

AbsParmBool AppModule::_verbose [protected]
 

Definition at line 218 of file APPModule.hh.

Referenced by AppModule(), TagFilterModule::beginJob(), TagFilterExample::beginJob(), TagFillExample::beginJob(), TagFastFilterExample::beginJob(), TagCreateModule::beginJob(), TagBdbLoad::beginJob(), BdbTransactionMgr::beginJob(), BdbSetTime::beginJob(), BdbEventOutput::beginJob(), BdbEventInput::beginJob(), TagFilterModule::beginRun(), TagFilterExample::beginRun(), TagFillExample::beginRun(), TagFastFilterExample::beginRun(), TagCreateModule::beginRun(), TagBdbLoad::beginRun(), BdbTransactionMgr::beginRun(), BdbEventOutput::beginRun(), BdbEventInput::beginRun(), BdbEventOutput::doCommit(), BdbEventOutput::doEvent(), BdbTransactionMgr::endJob(), BdbEventOutput::endJob(), BdbEventInput::endJob(), TagFilterExample::event(), TagFastFilterExample::event(), BdbSimpleFilter::event(), BdbSetTime::event(), BdbEventUpdate::event(), BdbEventMerge::event(), BdbEventCommit::event(), BdbCreateCM::event(), BdbAbsLoad::event(), BdbEventInput::inputEvent(), BdbEventInput::setSilent(), verbose(), BdbTransactionMgr::verboseOutput(), BdbEventOutput::verboseOutput(), and BdbEventInput::verboseOutput().

APPMenu AppModule::moduleMenu [static, protected]
 

Definition at line 87 of file APPModule.cc.

Referenced by APPMenu::exit(), and APPMenu::handle().

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