GApplication.hpp
4.38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/***************************************************************************
* GApplication.hpp - GammaLib application base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2012 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GApplication.hpp
* @brief GammaLib application base class
* @author Juergen Knoedlseder
*/
#ifndef GAPPLICATION_HPP
#define GAPPLICATION_HPP
/* __ Includes ___________________________________________________________ */
#include <ctime>
#include <vector>
#include <string>
#include "GBase.hpp"
#include "GLog.hpp"
#include "GPars.hpp"
/***********************************************************************//**
* @class GApplication
*
* @brief GammaLib application interface defintion
*
* This class provides the base class for ftools-like executables based on
* GammaLib. The ftools-like executables will be implemented as derived
* classes, and automatically have access to task parameters and the
* application logger.
***************************************************************************/
class GApplication : public GBase {
public:
// Constructors and destructors
GApplication(void);
GApplication(const std::string& name, const std::string& version);
GApplication(const std::string& name, const std::string& version,
int argc, char* argv[]);
GApplication(const GApplication& app);
~GApplication(void);
// Operators
GApplication& operator= (const GApplication& app);
GPar& operator[](const std::string& name);
const GPar& operator[](const std::string& name) const;
// Methods
void clear(void);
GApplication* clone(void) const;
std::string name(void) const;
std::string version(void) const;
double telapse(void) const;
double celapse(void) const;
void logFileOpen(bool clobber = true);
bool logTerse(void) const;
bool logNormal(void) const;
bool logExplicit(void) const;
bool logVerbose(void) const;
bool logDebug(void) const;
bool clobber(void) const;
bool haspar(const std::string& name) const;
std::string par_filename(void) const;
std::string log_filename(void) const;
void log_header(void);
void log_trailer(void);
void log_parameters(void);
std::string print(void) const;
// Public members
GLog log; //!< Application logger
protected:
// Protected methods
void init_members(void);
void copy_members(const GApplication& app);
void free_members(void);
// Protected data members
std::string m_name; //!< Application name
std::string m_version; //!< Application version
std::vector<std::string> m_args; //!< Command line arguments
std::time_t m_tstart; //!< Calendar start time of execution
std::clock_t m_cstart; //!< Clock start time of execution
GPars m_pars; //!< Application parameters
};
#endif /* GAPPLICATION_HPP */