bes  Updated for version 3.17.0
CmdApp Class Reference
Inheritance diagram for CmdApp:
Inheritance graph

Public Member Functions

string appName (void) const
 Returns the name of the application. More...
 
CmdClientclient ()
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual int initialize (int argC, char **argV)
 initialize the BES application More...
 
virtual int main (int argC, char **argV)
 main method of the BES application More...
 
virtual int run ()
 the applications functionality is implemented in the run method More...
 
virtual int terminate (int sig=0)
 clean up after the application More...
 

Static Public Member Functions

static void signalBrokenPipe (int sig)
 
static void signalCannotConnect (int sig)
 
static void signalInterrupt (int sig)
 
static void signalTerminate (int sig)
 
static BESAppTheApplication (void)
 Returns the BESApp application object for this application. More...
 

Protected Attributes

string _appName
 
bool _debug
 
bool _isInitialized
 

Static Protected Attributes

static BESApp_theApplication = 0
 

Detailed Description

Definition at line 39 of file CmdApp.h.

Member Function Documentation

string BESApp::appName ( void  ) const
inlineinherited

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.

Returns
name of the application

Definition at line 132 of file BESApp.h.

void CmdApp::dump ( std::ostream &  strm) const
virtual

Displays the pointer value of this instance

Parameters
strmC++ i/o stream to dump the information to

Reimplemented from BESBaseApp.

Definition at line 415 of file CmdApp.cc.

References BESBaseApp::dump(), and BESBaseApp::main().

int CmdApp::initialize ( int  argC,
char **  argV 
)
virtual
Returns
0 if successful and not 0 otherwise
Parameters
argCargc value passed to the main function
argVargv value passed to the main function
Exceptions
BESErrorif any exceptions or errors are encountered

Reimplemented from BESBaseApp.

Definition at line 197 of file CmdApp.cc.

References BESBaseApp::initialize(), and BESDebug::SetUp().

int BESBaseApp::main ( int  argC,
char **  argV 
)
virtualinherited

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.

Returns
0 if successful and not 0 otherwise
Parameters
argCargc value passed to the main function
argVargv value passed to the main function

Implements BESApp.

Definition at line 74 of file BESBaseApp.cc.

References BESBaseApp::initialize(), BESBaseApp::run(), and BESBaseApp::terminate().

int CmdApp::run ( void  )
virtual

It is up to the derived class to implement this method.

Returns
0 if successful and not 0 otherwise
Exceptions
BESErrorif the derived class does not implement this method

Reimplemented from BESBaseApp.

Definition at line 328 of file CmdApp.cc.

References BESError::get_message().

int BESBaseApp::terminate ( int  sig = 0)
virtualinherited

Cleans up any global variables registered with BESGlobalIQ

Returns
0 if successful and not 0 otherwise
Parameters
sigif the application is terminating due to a signal, otherwise 0 is passed.
See also
BESGlobalIQ

Implements BESApp.

Reimplemented in BESModuleApp, ServerApp, and StandAloneApp.

Definition at line 126 of file BESBaseApp.cc.

static BESApp* BESApp::TheApplication ( void  )
inlinestaticinherited
Returns
The application object

Definition at line 138 of file BESApp.h.


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