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  

APPExecutable Class Reference
[Framework]

#include <APPExecutable.hh>

Inheritance diagram for APPExecutable:

AppModule APPSequence 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 APPPath List of all members.

Public Types

enum  ExecType {
  APP_module, APP_framework, APP_input, APP_output,
  APP_filter, APP_noclone, APP_sequence, APP_path,
  APP_account
}

Public Methods

 APPExecutable ()
 APPExecutable (const char *const theName, const char *const theDescription=((void *) 0))
virtual ~APPExecutable ()
char * description () const
ExecType execType () const
AppFramework * framework () const
virtual bool isClonable () const
bool isEnabled () const
virtual bool passed () const
const char * name () const
virtual void flushReport () const
virtual void fullReport (const char *const aMessage) const
virtual void partialReport (const char *const aMessage) const
void partialReport (const std::string &aMessage) const
virtual void report (int mode=0) const
void setEnabled (bool mode)
void setFramework (const AppFramework *const theFrame)
virtual AppResult beginJob (AbsEvent *anEvent)=0
virtual AppResult beginRun (AbsEvent *anEvent)=0
virtual AppResult event (AbsEvent *anEvent)=0
virtual AppResult other (AbsEvent *anEvent)=0
virtual AppResult frame (AppFrame *aFrame, const AppStopType &theDispatchStopType)=0
virtual AppResult endRun (AbsEvent *anEvent)=0
virtual AppResult endJob (AbsEvent *anEvent)=0
virtual AppResult abortJob (AbsEvent *anEvent)=0

Static Public Methods

APPExecutable * narrow (APPExecutable *anExec, ExecType aType)

Protected Methods

 APPExecutable (const APPExecutable &)
APPExecutable & operator= (const APPExecutable &)
void setExecType (ExecType aType)

Protected Attributes

char * _description
char * _name
bool _isEnabled
bool _passed
ExecType _execType
AppFramework * _framework

Member Enumeration Documentation

enum APPExecutable::ExecType
 

Enumeration values:
APP_module 
APP_framework 
APP_input 
APP_output 
APP_filter 
APP_noclone 
APP_sequence 
APP_path 
APP_account 

Definition at line 70 of file APPExecutable.hh.

Referenced by AbsModuleMemento::exectype(), and AppMemento::restoreConfig().

Constructor & Destructor Documentation

APPExecutable::APPExecutable (    ) 
 

Definition at line 72 of file APPExecutable.cc.

References true.

APPExecutable::APPExecutable (  const char *const    theName,
const char *const    theDescription = ((void *) 0)
) 
 

Definition at line 81 of file APPExecutable.cc.

References _description, _name, and true.

APPExecutable::~APPExecutable (    )  [virtual]
 

Definition at line 103 of file APPExecutable.cc.

References _description, and _name.

APPExecutable::APPExecutable (  const APPExecutable &    )  [protected]
 

Member Function Documentation

virtual AppResult APPExecutable::abortJob (  AbsEvent *    anEvent )  [pure virtual]
 

Implemented in AppFramework, AppModule, APPSequence, and AppStreamsOutputModule.

virtual AppResult APPExecutable::beginJob (  AbsEvent *    anEvent )  [pure virtual]
 

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

virtual AppResult APPExecutable::beginRun (  AbsEvent *    anEvent )  [pure virtual]
 

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

Referenced by APPSequence::beginRun().

char* APPExecutable::description (    ) 
 

Referenced by BdbTransactionMgr::help(), BdbSimpleFilter::help(), BdbInspector::help(), BdbEventOutput::help(), BdbEventInput::help(), APPInputModule::report(), and report().

virtual AppResult APPExecutable::endJob (  AbsEvent *    anEvent )  [pure virtual]
 

Implemented in BdbCreateCM, BdbEventInput, BdbEventOutput, BdbTransactionMgr, AppFramework, AppModule, APPSequence, AppStreamsOutputModule, TagFastFilterByName, TagFilterByName, TagFilterInputModule, and TagInspector.

virtual AppResult APPExecutable::endRun (  AbsEvent *    anEvent )  [pure virtual]
 

Implemented in AppFramework, AppModule, APPSequence, and AppStreamsOutputModule.

Referenced by APPSequence::endRun().

virtual AppResult APPExecutable::event (  AbsEvent *    anEvent )  [pure virtual]
 

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

Referenced by APPSequence::event().

ExecType APPExecutable::execType (    ) 
 

Referenced by APPSequence::event(), AbsModuleMemento::exectype(), narrow(), and APPSequence::other().

void APPExecutable::flushReport (    )  [virtual]
 

Definition at line 150 of file APPExecutable.cc.

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

Implemented in AppFramework, AppModule, and APPSequence.

Referenced by APPSequence::frame().

AppFramework* APPExecutable::framework (    ) 
 

Referenced by APPInputCommand::addHandler(), BdbInputCommand::addHandler(), BdbCollectionCommand::addHandler(), APPSequence::append(), AppActionApplicator::beginJob(), AppActionApplicator::beginRun(), BdbCollectionCommand::contentsCollHandler(), AppOutputCommand::createHandler(), BdbTreeNodeCommand::createHandler(), BdbOutputCommand::createHandler(), AppOutputCommand::deleteHandler(), BdbTreeNodeCommand::deleteHandler(), BdbCollectionCommand::deleteHandler(), AppOutputCommand::destinationHandler(), BdbOutputCommand::destinationHandler(), AppOutputCommand::disableHandler(), AppActionCommand::disableHandler(), AppFrameMemento::Dump(), AppOutputCommand::enableHandler(), AppActionCommand::enableHandler(), AppActionApplicator::endJob(), AppActionApplicator::endRun(), APPSequence::event(), AppActionApplicator::event(), BdbCollectionCommand::eventsHandler(), AppModule::exit(), APPEchoCommand::handle(), AppOutputCommand::helpHandler(), AppFileOutputCommand::helpHandler(), BdbTreeNodeCommand::helpHandler(), BdbSetTruncTime::helpHandler(), BdbOutputCommand::helpHandler(), BdbCollectionCommand::helpHandler(), AppActionApplicator::inputEvent(), APPSequence::insert(), BdbTreeNodeCommand::listAllHandler(), BdbCollectionCommand::listAllHandler(), AppOutputCommand::listHandler(), APPInputCommand::listHandler(), AppActionCommand::listHandler(), BdbTreeNodeCommand::listLevelHandler(), BdbCollectionCommand::listLevelHandler(), BdbTreeNodeCommand::listNodeHandler(), BdbCollectionCommand::listNodeHandler(), BdbCollectionCommand::mapHandler(), BdbOutputCommand::masterHandler(), BdbTreeNodeCommand::moveHandler(), BdbCollectionCommand::moveHandler(), APPSequence::other(), AppActionApplicator::other(), AppActionApplicator::outputEvent(), AppOutputCommand::pathsHandler(), BdbCollectionCommand::precreateCleanupHandler(), APPInputCommand::removeHandler(), BdbCollectionCommand::removeHandler(), APPSequence::report(), APPInputModule::report(), report(), BdbOutputCommand::setHandler(), AppOutputCommand::statisticsHandler(), BdbEventOutput::transactionMgr(), BdbEventInput::transactionMgr(), and APPInputCommand::wipeoutHandler().

void APPExecutable::fullReport (  const char *const    aMessage )  const [virtual]
 

Definition at line 116 of file APPExecutable.cc.

Referenced by AppFramework::add(), APPInputCommand::addHandler(), BdbInputCommand::addHandler(), APPListDeleteAll(), AppModule::bindMethodToState(), AppFramework::continueHandler(), AppActionCommand::disableHandler(), AppConfigCommand::dumpHandler(), AppActionCommand::enableHandler(), AppModule::frame(), APPEchoCommand::handle(), APPCommand::handle(), AppModule::help(), AppFramework::help(), 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(), AppActionApplicator::inputEvent(), APPSequenceCommand::listHandler(), AppOutputCommand::listHandler(), APPModuleCommand::listHandler(), APPInputCommand::listHandler(), AppActionCommand::listHandler(), AbsParmString::listHandler(), AbsParmFilename::listHandler(), AbsParmDouble::listHandler(), AbsParmBool::listHandler(), AppMemento::makeClone(), AppModule::menuHandler(), AppMemento::missingModules(), AppActionApplicator::outputEvent(), APPInputModule::report(), report(), AbsParmString::setHandler(), AbsParmFilename::setHandler(), AbsParmDouble::setHandler(), AbsParmBool::setHandler(), AppFramework::setupTheApp(), AppModule::show(), AppFramework::show(), and AppOutputCommand::statisticsHandler().

virtual bool APPExecutable::isClonable (    )  [virtual]
 

Reimplemented in APPNoCloneModule.

bool APPExecutable::isEnabled (    ) 
 

Referenced by AppFramework::abortJob(), AppFramework::accountEvent(), AppFramework::beginJob(), APPSequence::beginRun(), AppFramework::continueHandler(), APPSequence::endRun(), APPSequence::event(), APPSequence::frame(), AbsModuleMemento::isEnabled(), APPSequence::other(), AppFramework::outputEvent(), APPInputModule::report(), report(), BdbEventOutput::transactionMgr(), and BdbEventInput::transactionMgr().

const char* APPExecutable::name (    ) 
 

Referenced by APPModuleCommand::accountHandler(), AppFramework::add(), BdbAbsLoad::addScribeForInput(), BdbAbsLoad::addScribeForOutput(), TagPlots::beginJob(), TagInspector::beginJob(), TagFilterModule::beginJob(), TagFilterInputByName::beginJob(), TagFilterExample::beginJob(), TagFilterByName::beginJob(), TagFillExample::beginJob(), TagFastFilterExample::beginJob(), TagFastFilterByName::beginJob(), TagCreateModule::beginJob(), TagBdbLoad::beginJob(), BdbTransactionMgr::beginJob(), BdbSetTime::beginJob(), BdbSetRevision::beginJob(), BdbEventOutput::beginJob(), BdbEventInput::beginJob(), TagFilterModule::beginRun(), TagFilterExample::beginRun(), TagFillExample::beginRun(), TagFastFilterExample::beginRun(), TagCreateModule::beginRun(), TagBdbLoad::beginRun(), BdbTransactionMgr::beginRun(), BdbEventOutput::beginRun(), BdbEventInput::beginRun(), AppModule::bindMethodToState(), BdbTransactionMgr::clientName(), BdbEventOutput::clientName(), BdbEventInput::clientName(), BdbEventOutput::conditionalCommit(), TagPlots::convertName(), BdbEventOutput::createAllInOnePlacement(), BdbEventOutput::createStandardPlacement(), BdbEventOutput::doCommit(), BdbEventOutput::doEvent(), AppFrameMemento::Dump(), AppFrameMemento::Dump_tcl(), TagInspector::endJob(), TagFilterInputModule::endJob(), TagFilterByName::endJob(), TagFastFilterByName::endJob(), BdbTransactionMgr::endJob(), BdbEventOutput::endJob(), BdbEventInput::endJob(), BdbCreateCM::endJob(), TagPlots::event(), TagInspector::event(), TagCreateEventId::event(), BdbSimpleFilter::event(), BdbEventUpdate::event(), BdbEventMerge::event(), BdbEventCommit::event(), BdbCreateCM::event(), BdbAbsLoad::event(), AppModule::help(), BdbTransactionMgr::help(), BdbSimpleFilter::help(), BdbInspector::help(), BdbEventUpdate::help(), BdbEventOutput::help(), BdbEventMerge::help(), BdbEventInput::help(), BdbEventCommit::help(), BdbEventInput::inputEvent(), APPModuleCommand::inputHandler(), BdbEventOutput::inputLogged(), APPSequenceCommand::insertHandler(), AbsParmString::listHandler(), AbsParmFilename::listHandler(), AbsParmDouble::listHandler(), AbsParmBool::listHandler(), AbsModuleMemento::name(), BdbEventInput::openCollection(), APPModuleCommand::outputHandler(), BdbEventInput::outputLogged(), BdbEventMerge::prepareCollection(), AppFramework::remove(), APPInputModule::report(), report(), and AppModule::show().

APPExecutable * APPExecutable::narrow (  APPExecutable *    anExec,
ExecType    aType
)  [static]
 

Definition at line 54 of file APPExecutable.cc.

References execType(), and result.

Referenced by AppFramework::fetchModule(), AppFramework::fetchPath(), AppFramework::fetchSequence(), AppFramework::hasModule(), AppFramework::hasPath(), AppFramework::hasSequence(), AppFramework::setAccountModule(), AppFramework::setInputModule(), and AppFramework::setOutputModule().

APPExecutable& APPExecutable::operator= (  const APPExecutable &    )  [protected]
 

virtual AppResult APPExecutable::other (  AbsEvent *    anEvent )  [pure virtual]
 

Implemented in AppFramework, AppModule, and APPSequence.

Referenced by APPSequence::other().

void APPExecutable::partialReport (  const std::string &    aMessage )  const [inline]
 

Definition at line 112 of file APPExecutable.hh.

References partialReport().

void APPExecutable::partialReport (  const char *const    aMessage )  const [virtual]
 

Definition at line 123 of file APPExecutable.cc.

Referenced by AppFramework::add(), APPInputCommand::addHandler(), BdbInputCommand::addHandler(), APPListDeleteAll(), AppModule::bindMethodToState(), AppModule::clone(), AppActionCommand::disableHandler(), AppConfigCommand::dumpHandler(), AppActionCommand::enableHandler(), APPEchoCommand::handle(), APPCommand::handle(), AppModule::help(), APPSequenceCommand::helpHandler(), APPPathCommand::helpHandler(), AppOutputCommand::helpHandler(), APPModuleCommand::helpHandler(), AppFileOutputCommand::helpHandler(), APPEventsCommand::helpHandler(), AppConfigCommand::helpHandler(), AppActionCommand::helpHandler(), BdbTreeNodeCommand::helpHandler(), BdbOutputCommand::helpHandler(), BdbCollectionCommand::helpHandler(), AppOutputCommand::listHandler(), APPInputCommand::listHandler(), AppActionCommand::listHandler(), AbsParmString::listHandler(), AbsParmFilename::listHandler(), AbsParmDouble::listHandler(), AbsParmBool::listHandler(), AppMemento::makeClone(), AppModule::menuHandler(), AppMemento::missingModules(), partialReport(), AppFramework::printName(), APPInputModule::report(), report(), AppFramework::setupTheApp(), AppModule::show(), AppFramework::show(), AppFramework::skipToIndent(), and AppOutputCommand::statisticsHandler().

virtual bool APPExecutable::passed (    )  [virtual]
 

Reimplemented in APPFilterModule, AppModule, and APPSequence.

Referenced by APPSequence::event(), and APPSequence::frame().

void APPExecutable::report (  int    mode = 0 )  const [virtual]
 

Reimplemented in APPInputModule, and APPSequence.

Definition at line 130 of file APPExecutable.cc.

References AppFramework::decreaseIndent(), description(), framework(), fullReport(), AppFramework::increaseIndent(), isEnabled(), name(), partialReport(), AppFramework::printName(), and AppFramework::skipToIndent().

Referenced by APPSequence::report().

void APPExecutable::setEnabled (  bool    mode ) 
 

Referenced by APPSequenceCommand::disableHandler(), APPModuleCommand::disableHandler(), APPSequenceCommand::enableHandler(), APPModuleCommand::enableHandler(), AppMemento::restoreConfig(), AppFramework::setAccountModule(), AppFramework::setInputModule(), and AppFramework::setOutputModule().

void APPExecutable::setExecType (  ExecType    aType )  [protected]
 

void APPExecutable::setFramework (  const AppFramework *const    theFrame ) 
 

Referenced by AppFramework::add().

Member Data Documentation

char* APPExecutable::_description [protected]
 

Definition at line 146 of file APPExecutable.hh.

Referenced by APPExecutable(), and ~APPExecutable().

ExecType APPExecutable::_execType [protected]
 

Definition at line 150 of file APPExecutable.hh.

Referenced by AppAccountModule::AppAccountModule(), APPFilterModule::APPFilterModule(), APPInputModule::APPInputModule(), AppModule::AppModule(), APPNoCloneModule::APPNoCloneModule(), APPOutputModule::APPOutputModule(), APPPath::APPPath(), and APPSequence::APPSequence().

AppFramework* APPExecutable::_framework [protected]
 

Definition at line 151 of file APPExecutable.hh.

bool APPExecutable::_isEnabled [protected]
 

Definition at line 148 of file APPExecutable.hh.

char* APPExecutable::_name [protected]
 

Definition at line 147 of file APPExecutable.hh.

Referenced by APPExecutable(), and ~APPExecutable().

bool APPExecutable::_passed [protected]
 

Definition at line 149 of file APPExecutable.hh.

Referenced by APPSequence::passed(), APPFilterModule::passed(), APPSequence::setPassed(), and APPFilterModule::setPassed().

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