OPeNDAP Hyrax Back End Server (BES) Updated for version 3.8.3
|
#include <StandAloneApp.h>
Public Member Functions | |
string | appName (void) const |
Returns the name of the application. | |
StandAloneClient * | client () |
virtual void | dump (ostream &strm) const |
dumps information about this object | |
virtual void | dump (ostream &strm) const |
virtual int | initialize (int argC, char **argV) |
Load and initialize any BES modules. | |
virtual int | main (int argC, char **argV) |
main method of the BES application | |
virtual int | run () |
the applications functionality is implemented in the run method | |
StandAloneApp () | |
virtual int | terminate (int sig=0) |
clean up after the application | |
virtual | ~StandAloneApp () |
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 = 0 |
Definition at line 42 of file StandAloneApp.h.
StandAloneApp::StandAloneApp | ( | ) |
Definition at line 56 of file StandAloneApp.cc.
StandAloneApp::~StandAloneApp | ( | ) | [virtual] |
Definition at line 66 of file StandAloneApp.cc.
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 BESBaseApp::dump(), ServerApp::initialize(), CmdApp::signalBrokenPipe(), CmdApp::signalCannotConnect(), CmdApp::signalInterrupt(), and CmdApp::signalTerminate().
StandAloneClient* StandAloneApp::client | ( | ) | [inline] |
Definition at line 63 of file StandAloneApp.h.
virtual void StandAloneApp::dump | ( | ostream & | strm | ) | const [virtual] |
void BESModuleApp::dump | ( | ostream & | strm | ) | const [virtual, inherited] |
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.
strm | C++ i/o stream to dump the information to |
Reimplemented from BESBaseApp.
Definition at line 254 of file BESModuleApp.cc.
References BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().
int StandAloneApp::initialize | ( | int | argC, |
char ** | argV | ||
) | [virtual] |
Load and initialize any BES modules.
argC | argc value passed to the main function |
argV | argv value passed to the main function |
Reimplemented from BESModuleApp.
Definition at line 98 of file StandAloneApp.cc.
References BESDEBUG, TheBESKeys::ConfigFile, BESError::get_message(), and BESDebug::SetUp().
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.
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, BESBaseApp::initialize(), BESBaseApp::run(), and BESBaseApp::terminate().
Referenced by main().
int StandAloneApp::run | ( | void | ) | [virtual] |
the applications functionality is implemented in the run method
It is up to the derived class to implement this method.
BESError | if the derived class does not implement this method |
Reimplemented from BESBaseApp.
Definition at line 242 of file StandAloneApp.cc.
References BESDEBUG, StandAloneClient::executeCommands(), BESError::get_message(), StandAloneClient::interact(), and StandAloneClient::setOutput().
int StandAloneApp::terminate | ( | int | sig = 0 | ) | [virtual] |
clean up after the application
sig | return value from run that should be returned from method |
Reimplemented from BESModuleApp.
Definition at line 329 of file StandAloneApp.cc.
References BESDEBUG.
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] |
Definition at line 60 of file BESApp.h.
Referenced by BESApp::appName(), and BESBaseApp::main().
bool BESApp::_debug [protected, inherited] |
bool BESApp::_isInitialized [protected, inherited] |
Definition at line 62 of file BESApp.h.
Referenced by BESBaseApp::dump(), BESBaseApp::initialize(), and BESBaseApp::terminate().
BESApp * BESApp::_theApplication = 0 [static, protected, inherited] |
Definition at line 63 of file BESApp.h.
Referenced by BESApp::TheApplication().