GApplication.hpp
12.9 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/***************************************************************************
* GApplication.hpp - GammaLib application base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2021 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 "GApplicationPars.hpp"
/* __ Forward declarations _______________________________________________ */
class GFitsHDU;
class GFits;
class GFilename;
/***********************************************************************//**
* @class GApplication
*
* @brief GammaLib application interface definition
*
* 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,
const GApplicationPars& pars);
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);
GApplicationPar& operator[](const int& index);
const GApplicationPar& operator[](const int& index) const;
GApplicationPar& operator[](const std::string& name);
const GApplicationPar& operator[](const std::string& name) const;
// Methods
void clear(void);
GApplication* clone(void) const;
std::string classname(void) const;
const std::string& name(void) const;
const std::string& version(void) const;
double telapse(void) const;
double celapse(void) const;
double eCO2(void) const;
void logFileOpen(const bool& clobber = true);
void logFileClose(void);
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 has_par(const std::string& name) const;
const std::string& par_filename(void) const;
const std::string& log_filename(void) const;
void log_header(void);
void log_trailer(void);
void log_string(const GChatter& chatter,
const std::string& string,
const bool& linefeed = true);
void log_value(const GChatter& chatter,
const std::string& name,
const std::string& value);
void log_value(const GChatter& chatter,
const std::string& name,
const int& value);
void log_value(const GChatter& chatter,
const std::string& name,
const double& value);
void log_header1(const GChatter& chatter,
const std::string& header);
void log_header2(const GChatter& chatter,
const std::string& header);
void log_header3(const GChatter& chatter,
const std::string& header);
void log_parameters(const GChatter& chatter);
const bool& need_help(void) const;
const GApplicationPars& pars(void) const;
void pars(const GApplicationPars& pars);
const std::vector<std::string>& args(void) const;
void stamp(GFitsHDU& hdu) const;
void stamp(GFits& fits) const;
void stamp(const GFilename& filename) const;
std::string print(const GChatter& chatter = NORMAL) const;
// Public members
GLog log; //!< Application logger
protected:
// Protected methods
void init_members(void);
void copy_members(const GApplication& app);
void free_members(void);
void set_log_chatter(void);
void set_log_filename(void);
// Protected data members
std::string m_name; //!< Application name
std::string m_version; //!< Application version
std::string m_parfile; //!< Parameter filename
std::string m_logfile; //!< Log filename
std::vector<std::string> m_args; //!< Command line arguments
std::time_t m_tstart; //!< Calendar start time of execution
double m_cstart; //!< Clock start time of execution
GApplicationPars m_pars; //!< Application parameters
bool m_pars_loaded; //!< Application parameters loaded
bool m_need_help; //!< --help specified
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GApplication").
***************************************************************************/
inline
std::string GApplication::classname(void) const
{
return ("GApplication");
}
/***********************************************************************//**
* @brief Parameter access operator
*
* @param[in] name Parameter name.
* @return Reference to application parameter.
*
* Returns a reference to the application parameter with the given @p name.
***************************************************************************/
inline
GApplicationPar& GApplication::operator[](const std::string& name)
{
return (m_pars[name]);
}
/***********************************************************************//**
* @brief Parameter access operator (const version)
*
* @param[in] name Parameter name.
* @return Constant reference to application parameter
*
* Returns a const reference to the application parameter with the given
* @p name.
***************************************************************************/
inline
const GApplicationPar& GApplication::operator[](const std::string& name) const
{
return (m_pars[name]);
}
/***********************************************************************//**
* @brief Parameter access operator
*
* @param[in] index Parameter index [0,...,pars().size()-1].
* @return Reference to application parameter
*
* Returns a reference to the application parameter with the given @p index.
* No range checking is performed for the index.
***************************************************************************/
inline
GApplicationPar& GApplication::operator[](const int& index)
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Parameter access operator (const version)
*
* @param[in] index Parameter index [0,...,pars().size()-1].
* @return Constant reference to application parameter
*
* Returns a const reference to the application parameter with the given
* @p index. No range checking is performed for the index.
***************************************************************************/
inline
const GApplicationPar& GApplication::operator[](const int& index) const
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Return application name
*
* @return Application name.
***************************************************************************/
inline
const std::string& GApplication::name(void) const
{
return m_name;
}
/***********************************************************************//**
* @brief Return application version
*
* @return Application version.
***************************************************************************/
inline
const std::string& GApplication::version(void) const
{
return m_version;
}
/***********************************************************************//**
* @brief Signal if specified parameter exists
*
* @param[in] name Parameter name.
* @return True if an application parameter with the specified name exists.
***************************************************************************/
inline
bool GApplication::has_par(const std::string& name) const
{
return (m_pars.contains(name));
}
/***********************************************************************//**
* @brief Returns parameter filename
*
* @return Parameter filename.
***************************************************************************/
inline
const std::string& GApplication::par_filename(void) const
{
// Return
return (m_parfile);
}
/***********************************************************************//**
* @brief Returns log filename
*
* @return Log filename.
***************************************************************************/
inline
const std::string& GApplication::log_filename(void) const
{
// Set logfile name from parameters (in case it has changed)
const_cast<GApplication*>((this))->set_log_filename();
// Return
return (m_logfile);
}
/***********************************************************************//**
* @brief Signals if --help option has been specified
*
* @return True if --help option has been specified.
***************************************************************************/
inline
const bool& GApplication::need_help(void) const
{
// Return
return (m_need_help);
}
/***********************************************************************//**
* @brief Return application parameters
*
* @return Application parameters.
***************************************************************************/
inline
const GApplicationPars& GApplication::pars(void) const
{
return m_pars;
}
/***********************************************************************//**
* @brief Set application parameters
*
* @param[in] pars Application parameters.
***************************************************************************/
inline
void GApplication::pars(const GApplicationPars& pars)
{
m_pars = pars;
return;
}
/***********************************************************************//**
* @brief Return command line arguments
*
* @return Command line arguments.
***************************************************************************/
inline
const std::vector<std::string>& GApplication::args(void) const
{
return m_args;
}
#endif /* GAPPLICATION_HPP */