Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

BESModuleApp Class Reference

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

#include <BESModuleApp.h>

Inheritance diagram for BESModuleApp:

[legend]
Collaboration diagram for BESModuleApp:
[legend]
List of all members.

Public Member Functions

 BESModuleApp (void)
 Default constructor.
virtual ~BESModuleApp (void)
 Default destructor.
virtual int initialize (int argC, char **argV)
 Load and initialize any BES modules.
virtual int terminate (int sig=0)
 clean up after the application
virtual void dump (ostream &strm) const
 dumps information about this object
virtual int main (int argC, char **argV)
 main method of the BES application
virtual int run (void)
 the applications functionality is implemented in the run method
string appName (void) const
 Returns the name of the application.

Static Public Member Functions

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

Protected Attributes

string _appName
bool _debug
bool _isInitialized

Static Protected Attributes

static BESApp_theApplication = 0

Classes

struct  _bes_module

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


Constructor & Destructor Documentation

BESModuleApp::BESModuleApp void   ) 
 

Default constructor.

Initialized the static _the Applicatioon to point to this application object

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.


Member Function Documentation

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.

Returns:
name of the application

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

Parameters:
strm C++ i/o stream to dump the information to

Reimplemented from BESBaseApp.

Reimplemented in ServerApp.

int BESModuleApp::initialize int  argC,
char **  argV
[virtual]
 

Load and initialize any BES modules.

Returns:
0 if successful and not 0 otherwise
Parameters:
argC argc value passed to the main function
argV argv value passed to the main function

Reimplemented from BESBaseApp.

Reimplemented in ServerApp.

int BESBaseApp::main int  argC,
char **  argV
[virtual, inherited]
 

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.

Returns:
0 if successful and not 0 otherwise
Parameters:
argC argc value passed to the main function
argV argv value passed to the main function

Implements BESApp.

int BESBaseApp::run void   )  [virtual, inherited]
 

the applications functionality is implemented in the run method

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

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

Implements BESApp.

Reimplemented in ServerApp, and CmdApp.

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:
sig if the application is terminating due to a signal, otherwise 0 is passed.

Reimplemented from BESBaseApp.

Reimplemented in ServerApp.

static BESApp* BESApp::TheApplication void   )  [inline, static, inherited]
 

Returns the BESApp application object for this application.

Returns:
The application object


Member Data Documentation

string BESApp::_appName [protected, inherited]
 

bool BESApp::_debug [protected, inherited]
 

bool BESApp::_isInitialized [protected, inherited]
 

BESApp * BESApp::_theApplication = 0 [static, protected, inherited]
 


The documentation for this class was generated from the following files:
Generated on Thu May 3 23:11:01 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.4.4