bes  Updated for version 3.20.6
BESModuleApp Class Reference

Base application object for all BES applications. More...

#include <BESModuleApp.h>

Collaboration diagram for BESModuleApp:
Collaboration graph

Public Member Functions

std::string appName (void) const
 Returns the name of the application. More...
 
 BESModuleApp (void)
 Default constructor. More...
 
virtual void dump (std::ostream &strm) const
 dumps information about this object More...
 
virtual int initialize (int argC, char **argV)
 Load and initialize any BES modules. More...
 
virtual int main (int argC, char **argV)
 main routine, the main entry point for any BES applications. More...
 
virtual int run (void)
 The body of the application, implementing the primary functionality of the BES application. More...
 
virtual int terminate (int sig=0)
 clean up after the application More...
 
virtual ~BESModuleApp (void)
 Default destructor. More...
 

Static Public Member Functions

static BESAppTheApplication (void)
 Returns the BESApp application object for this application. More...
 

Protected Attributes

std::string _appName
 
bool _debug
 
bool _isInitialized
 

Static Protected Attributes

static BESApp_theApplication = 0
 

Detailed Description

Base application object for all BES applications.

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.

See also
BESApp
BESGlobalIQ

Definition at line 56 of file BESModuleApp.h.

Constructor & Destructor Documentation

◆ BESModuleApp()

BESModuleApp::BESModuleApp ( void  )

Default constructor.

Initialized the static _the Applicatioon to point to this application object

Definition at line 49 of file BESModuleApp.cc.

◆ ~BESModuleApp()

BESModuleApp::~BESModuleApp ( 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 BESModuleApp.cc.

Member Function Documentation

◆ appName()

std::string BESApp::appName ( void  ) const
inlineinherited

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.

Returns
name of the application

Definition at line 128 of file BESApp.h.

◆ dump()

void BESModuleApp::dump ( std::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 and whether the application debugging is turned on.

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

Implements BESApp.

Reimplemented in ServerApp, and StandAloneApp.

Definition at line 242 of file BESModuleApp.cc.

◆ initialize()

int BESModuleApp::initialize ( int  argC,
char **  argV 
)
virtual

Load and initialize any BES modules.

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

Reimplemented from BESApp.

Reimplemented in ServerApp, and StandAloneApp.

Definition at line 69 of file BESModuleApp.cc.

◆ main()

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

main routine, the main entry point for any BES applications.

main method of the BES application

It is up to the derived classes of BESApp to implement the main routine. However, the main method should call initialize, run and terminate in that order and should pass to the initialize routine the arguments argc and argv passed to the main function.

Parameters
argCnumber of arguments passed to the application, which is argc passed to the main function.
argVarguments passed to the application, which is argv passed to the main function.

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

Definition at line 54 of file BESApp.cc.

◆ run()

int BESApp::run ( void  )
virtualinherited

The body of the application, implementing the primary functionality of the BES application.

the applications functionality is implemented in the run method

It is up to the derived classes of BESApp to implement the run method.

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 in CmdApp, ServerApp, and StandAloneApp.

Definition at line 86 of file BESApp.cc.

◆ terminate()

int BESModuleApp::terminate ( int  sig = 0)
virtual

clean up after the application

Calls terminate on each of the loaded modules

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

Reimplemented from BESApp.

Reimplemented in ServerApp, and StandAloneApp.

Definition at line 201 of file BESModuleApp.cc.

◆ TheApplication()

static BESApp* BESApp::TheApplication ( void  )
inlinestaticinherited

Returns the BESApp application object for this application.

Returns
The application object

Definition at line 137 of file BESApp.h.


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