GApplication.i
11 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
/***************************************************************************
* GApplication.i - GammaLib application base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2017 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.i
* @brief GammaLib application base class Python interface definition
* @author Juergen Knoedlseder
*/
%{
/* Put headers and other declarations here that are needed for compilation */
#include "GApplication.hpp"
#include "GTools.hpp"
%}
// Include (int ARGC, char **ARGV) typemap to allow passing command line
// arguments to GApplication constructor
%include "argcargv.i"
/***********************************************************************//**
* @class GApplication
*
* @brief GammaLib application Python interface definition.
*
* The GApplication class is the base class for all tools and scripts that
* will be based on GammaLib.
***************************************************************************/
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);
// Public methods
double telapse(void) const;
double celapse(void) const;
void logFileOpen(const bool& clobber = true);
void logFileClose(void);
// Ignore base class methods and make methods private in Python by
// prepending an underscore
%ignore clear;
%ignore clone;
%ignore classname;
%rename(_name) name;
%rename(_version) version;
%rename(_logTerse) logTerse;
%rename(_logNormal) logNormal;
%rename(_logExplicit) logExplicit;
%rename(_logVerbose) logVerbose;
%rename(_logDebug) logDebug;
%rename(_clobber) clobber;
%rename(_par_filename) par_filename;
%rename(_log_filename) log_filename;
%rename(_log_header) log_header;
%rename(_log_trailer) log_trailer;
%rename(_need_help) need_help;
%rename(_log) log;
// 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;
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);
const bool& need_help(void) const;
const GApplicationPars& pars(void) const;
void pars(const GApplicationPars& pars);
// Public members
GLog log; //!< Application logger
};
/***********************************************************************//**
* @brief GApplication Python class extension
***************************************************************************/
%pythoncode %{
# Log the value of a parameter
def _log_value(self, chatter, name, value):
string = gammalib.parformat(str(name))+str(value)
self._log_string(chatter, string)
GApplication._log_value = _log_value
%}
/***********************************************************************//**
* @brief GApplication C++ class extension
***************************************************************************/
%extend GApplication {
void _log_string(const int& chatter, const std::string& string,
const bool& linefeed = true) {
self->log_string(GChatter(chatter), string, linefeed);
}
void _log_header1(const int& chatter, const std::string& header) {
self->log_header1(GChatter(chatter), header);
}
void _log_header2(const int& chatter, const std::string& header) {
self->log_header2(GChatter(chatter), header);
}
void _log_header3(const int& chatter, const std::string& header) {
self->log_header3(GChatter(chatter), header);
}
void _log_parameters(const int& chatter) {
self->log_parameters(GChatter(chatter));
}
GApplicationPar& __getitem__(const std::string& name) {
return (*self)[name];
}
void __setitem__(const std::string& name, const GApplicationPar& val) {
(*self)[name] = val;
return;
}
void __setitem__(const std::string& name, const bool& val) {
GApplicationPar& par = (*self)[name];
if (par.type() == "b") {
par.boolean(val);
}
else {
std::string msg = "Attempt to set \""+par.type()+
"\" parameter \""+name+"\" with boolean "
"value \""+gammalib::str(val)+"\".";
throw GException::invalid_argument("__setitem__(std::string, int)",
msg);
}
return;
}
void __setitem__(const std::string& name, const int& val) {
GApplicationPar& par = (*self)[name];
if (par.type() == "r") {
par.real(val);
}
else if (par.type() == "i") {
par.integer(val);
}
else if (par.type() == "b") {
par.boolean(val);
}
else if (par.type() == "t") {
par.value(gammalib::str(val));
}
else {
std::string msg = "Attempt to set \""+par.type()+
"\" parameter \""+name+"\" with integer "
"value \""+gammalib::str(val)+"\".";
throw GException::invalid_argument("__setitem__(std::string, int)",
msg);
}
return;
}
void __setitem__(const std::string& name, const double& val) {
GApplicationPar& par = (*self)[name];
if (par.type() == "t") {
par.value(gammalib::str(val));
}
else {
par.real(val);
}
return;
}
void __setitem__(const std::string& name, const std::string& val) {
GApplicationPar& par = (*self)[name];
if (par.type() == "s") {
par.string(val);
}
else if (par.type().substr(0,1) == "f") {
par.filename(val);
}
else if ((par.type() == "r") || (par.type() == "i")) {
std::string lval = gammalib::tolower(val);
if (lval == "indef" ||
lval == "none" ||
lval == "undef" ||
lval == "undefined" ||
lval == "inf" ||
lval == "infinity" ||
lval == "nan") {
par.value(val);
}
else {
std::string msg = "Attempt to set \""+par.type()+
"\" parameter \""+name+"\" with string "
"value \""+val+"\".";
throw GException::invalid_argument("__setitem__(std::string, std::string)",
msg);
}
}
else if (par.type() == "t") {
par.value(val);
}
else {
std::string msg = "Attempt to set \""+par.type()+
"\" parameter \""+name+"\" with string "
"value \""+val+"\".";
throw GException::invalid_argument("__setitem__(std::string, std::string)",
msg);
}
return;
}
void __setitem__(const std::string& name, const GTime& val) {
GApplicationPar& par = (*self)[name];
if (par.type() == "t") {
par.time(val);
}
else {
std::string msg = "Attempt to set \""+par.type()+
"\" parameter \""+name+"\" with time "
"value \""+val.print()+"\".";
throw GException::invalid_argument("__setitem__(std::string, GTime)",
msg);
}
return;
}
GApplicationPar& __getitem__(const int& index) {
// Counting from start, e.g. [2]
if (index >= 0 && index < self->pars().size()) {
return (*self)[index];
}
// Counting from end, e.g. [-1]
else if (index < 0 && self->pars().size()+index >= 0) {
return (*self)[self->pars().size()+index];
}
else {
throw GException::out_of_range("__getitem__(int)", "Application "
"parameter index",
index, self->pars().size());
}
}
void __setitem__(const int& index, const GApplicationPar& val) {
// Counting from start, e.g. [2]
if (index >= 0 && index < self->pars().size()) {
(*self)[index] = val;
}
// Counting from end, e.g. [-1]
else if (index < 0 && self->pars().size()+index >= 0) {
(*self)[self->pars().size()+index] = val;
}
else {
throw GException::out_of_range("__setitem__(int)", "Application "
"parameter index",
index, self->pars().size());
}
}
GApplication copy() {
return (*self);
}
};