#include <BESBaseApp.h>
Inheritance diagram for BESBaseApp:
Public Member Functions | |
BESBaseApp (void) | |
Default constructor. | |
virtual | ~BESBaseApp (void) |
Default destructor. | |
virtual int | main (int argC, char **argV) |
main method of the BES application | |
virtual int | initialize (int argC, char **argV) |
initialize the BES application | |
virtual int | run (void) |
the applications functionality is implemented in the run method | |
virtual int | terminate (int sig=0) |
clean up after the application | |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
string | appName (void) const |
Returns the name of the application. | |
Static Public Member Functions | |
static BESApp * | TheApplication (void) |
Returns the BESApp application object for this application. | |
Protected Attributes | |
string | _appName |
bool | _debug |
bool | _isInitialized |
Static Protected Attributes | |
static BESApp * | _theApplication |
Implements the initialization method to initialize all global objects registered with the Global Initialization routines of BES.
Implements the terminate method to clean up any global objects registered with the Global Initialization routines of BES.
It is up to the derived classes to implement the run method.
Definition at line 54 of file BESBaseApp.h.
BESBaseApp::BESBaseApp | ( | void | ) |
Default constructor.
Initialized the static _the Applicatioon to point to this application object
Definition at line 49 of file BESBaseApp.cc.
References BESApp::_theApplication.
BESBaseApp::~BESBaseApp | ( | void | ) | [virtual] |
Default destructor.
sets the static _theApplicaiton to null. Does not call terminate. It is up to the main method to call the terminate method.
Definition at line 59 of file BESBaseApp.cc.
References BESApp::_theApplication.
int BESBaseApp::main | ( | int | argC, | |
char ** | argV | |||
) | [virtual] |
main method of the BES application
sets the appName to argv[0], then calls initialize, run, and terminate in that order. Exceptions should be caught in the individual methods initialize, run and terminate and handled there.
argC | argc value passed to the main function | |
argV | argv value passed to the main function |
Implements BESApp.
Definition at line 75 of file BESBaseApp.cc.
References BESApp::_appName, initialize(), run(), and terminate().
Referenced by main().
Here is the call graph for this function:
int BESBaseApp::initialize | ( | int | argC, | |
char ** | argV | |||
) | [virtual] |
initialize the BES application
uses the BESGlobalIQ static method BESGlobalInit to initialize any global variables needed by this application
argC | argc value passed to the main function | |
argV | argv value passed to the main function |
BESException | if any exceptions or errors are encountered |
Implements BESApp.
Reimplemented in BESModuleApp, ServerApp, and CmdApp.
Definition at line 103 of file BESBaseApp.cc.
References BESApp::_isInitialized, BESGlobalIQ::BESGlobalInit(), and BESException::get_message().
Referenced by CmdApp::initialize(), BESModuleApp::initialize(), and main().
Here is the call graph for this function:
int BESBaseApp::run | ( | void | ) | [virtual] |
the applications functionality is implemented in the run method
It is up to the derived class to implement this method.
BESException | if the derived class does not implement this method |
Implements BESApp.
Reimplemented in ServerApp, and CmdApp.
Definition at line 141 of file BESBaseApp.cc.
Referenced by main().
int BESBaseApp::terminate | ( | int | sig = 0 |
) | [virtual] |
clean up after the application
Cleans up any global variables registered with BESGlobalIQ
sig | if the application is terminating due to a signal, otherwise 0 is passed. |
Implements BESApp.
Reimplemented in BESModuleApp, and ServerApp.
Definition at line 158 of file BESBaseApp.cc.
References BESApp::_isInitialized, and BESGlobalIQ::BESGlobalQuit().
Referenced by main(), and BESModuleApp::terminate().
Here is the call graph for this function:
void BESBaseApp::dump | ( | ostream & | strm | ) | const [virtual] |
dumps information about this object
Displays the pointer value of this instance along with the name of the application, whether the application is initialized or not
strm | C++ i/o stream to dump the information to |
Implements BESApp.
Reimplemented in BESModuleApp, ServerApp, and CmdApp.
Definition at line 173 of file BESBaseApp.cc.
References BESApp::_isInitialized, BESApp::appName(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
Referenced by CmdApp::dump().
Here is the call graph for this function:
string BESApp::appName | ( | void | ) | const [inline, inherited] |
Returns the name of the application.
The name of the application is typically argv[0] passed into the main function. But could be passed into the application or derived in a different way.
Definition at line 132 of file BESApp.h.
References BESApp::_appName.
Referenced by dump(), ServerApp::initialize(), CmdApp::signalBrokenPipe(), CmdApp::signalCannotConnect(), CmdApp::signalInterrupt(), and CmdApp::signalTerminate().
static BESApp* BESApp::TheApplication | ( | void | ) | [inline, static, inherited] |
Returns the BESApp application object for this application.
Definition at line 138 of file BESApp.h.
References BESApp::_theApplication.
Referenced by ServerApp::initialize(), CmdApp::signalBrokenPipe(), CmdApp::signalCannotConnect(), ServerApp::signalInterrupt(), CmdApp::signalInterrupt(), ServerApp::signalRestart(), ServerApp::signalTerminate(), and CmdApp::signalTerminate().
string BESApp::_appName [protected, inherited] |
bool BESApp::_debug [protected, inherited] |
bool BESApp::_isInitialized [protected, inherited] |
BESApp * BESApp::_theApplication [static, protected, inherited] |
Definition at line 63 of file BESApp.h.
Referenced by BESBaseApp(), BESApp::TheApplication(), and ~BESBaseApp().