bes Updated for version 3.20.10
BESApp.h
1// BESApp.h
2
3// This file is part of bes, A C++ back-end server implementation framework
4// for the OPeNDAP Data Access Protocol.
5
6// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8//
9// This library is free software; you can redistribute it and/or
10// modify it under the terms of the GNU Lesser General Public
11// License as published by the Free Software Foundation; either
12// version 2.1 of the License, or (at your option) any later version.
13//
14// This library is distributed in the hope that it will be useful,
15// but WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17// Lesser General Public License for more details.
18//
19// You should have received a copy of the GNU Lesser General Public
20// License along with this library; if not, write to the Free Software
21// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22//
23// You can contact University Corporation for Atmospheric Research at
24// 3080 Center Green Drive, Boulder, CO 80301
25
26// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27// Please read the full copyright statement in the file COPYRIGHT_UCAR.
28//
29// Authors:
30// pwest Patrick West <pwest@ucar.edu>
31// jgarcia Jose Garcia <jgarcia@ucar.edu>
32
33#ifndef A_BESApp_H
34#define A_BESApp_H
35
36#include <map>
37#include <string>
38
39#include "BESObj.h"
40
56class BESApp: public BESObj {
57protected:
58 std::string _appName;
59 bool _debug;
60 bool _isInitialized;
61 static BESApp * _theApplication;
62 BESApp(void) : _debug(false), _isInitialized(false) { }
63public:
64 virtual ~BESApp() { }
65
78 virtual int main(int argC, char **argV);
79
90 virtual int initialize(int argC, char **argV);
91
98 virtual int run(void);
99
109 virtual int terminate(int sig = 0);
110
118 virtual void dump(std::ostream &strm) const = 0;
119
128 std::string appName(void) const
129 {
130 return _appName;
131 }
132
137 static BESApp * TheApplication(void)
138 {
139 return _theApplication;
140 }
141};
142
143#endif
144
Application class for BES applications.
Definition: BESApp.h:56
virtual int initialize(int argC, char **argV)
Initialize the application using the passed argc and argv values.
Definition: BESApp.cc:72
virtual int terminate(int sig=0)
Clean up after the application.
Definition: BESApp.cc:102
virtual void dump(std::ostream &strm) const =0
dumps information about this object
Definition: BESApp.cc:115
virtual int run(void)
The body of the application, implementing the primary functionality of the BES application.
Definition: BESApp.cc:86
static BESApp * TheApplication(void)
Returns the BESApp application object for this application.
Definition: BESApp.h:137
std::string appName(void) const
Returns the name of the application.
Definition: BESApp.h:128
virtual int main(int argC, char **argV)
main routine, the main entry point for any BES applications.
Definition: BESApp.cc:54
top level BES object to house generic methods
Definition: BESObj.h:50