GMWLObservation.hpp
7.89 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
/***************************************************************************
* GMWLObservation.hpp - Multi-wavelength observation class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2015 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 GMWLObservation.hpp
* @brief Multi-wavelength observation class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMWLOBSERVATION_HPP
#define GMWLOBSERVATION_HPP
/* __ Includes ___________________________________________________________ */
#include "GObservation.hpp"
#include "GTime.hpp"
#include "GModel.hpp"
#include "GMWLResponse.hpp"
/***********************************************************************//**
* @class GMWLObservation
*
* @brief Interface class for multi-wavelength observations
*
* This class implements a multi-wavelength observation. A multi-wavelength
* observation contains spectral points obtained with an unspecified
* instrument. The spectral points are given in physical units.
***************************************************************************/
class GMWLObservation : public GObservation {
public:
// Constructors and destructors
GMWLObservation(void);
explicit GMWLObservation(const std::string& filename);
GMWLObservation(const GMWLObservation& obs);
virtual ~GMWLObservation(void);
// Operators
virtual GMWLObservation& operator= (const GMWLObservation& obs);
// Implement pure virtual methods
virtual void clear(void);
virtual GMWLObservation* clone(void) const;
virtual std::string classname(void) const;
virtual void response(const GResponse& rsp);
virtual const GMWLResponse* response(void) const;
virtual std::string instrument(void) const;
virtual double ontime(void) const;
virtual double livetime(void) const;
virtual double deadc(const GTime& time) const;
virtual void read(const GXmlElement& xml);
virtual void write(GXmlElement& xml) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
void load(const std::string& filename);
const std::string& filename(void) const;
const std::string& extno(void) const;
const std::string& extname(void) const;
void filename(const std::string& filename);
void extno(const std::string& extno);
void extname(const std::string& extname);
protected:
// Protected methods
void init_members(void);
void copy_members(const GMWLObservation& obs);
void free_members(void);
// Protected members
std::string m_instrument; //!< Instrument name
std::string m_filename; //!< Filename
std::string m_extno; //!< Extension number
std::string m_extname; //!< Extension name
GMWLResponse m_response; //!< Response function
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GMWLObservation").
***************************************************************************/
inline
std::string GMWLObservation::classname(void) const
{
return ("GMWLObservation");
}
/***********************************************************************//**
* @brief Return response
*
* @return Response.
***************************************************************************/
inline
const GMWLResponse* GMWLObservation::response(void) const
{
return &m_response;
}
/***********************************************************************//**
* @brief Return instrument name
*
* @return Instrument name.
***************************************************************************/
inline
std::string GMWLObservation::instrument(void) const
{
return "MWL";
}
/***********************************************************************//**
* @brief Return ontime
*
* @return Ontime (always 1).
***************************************************************************/
inline
double GMWLObservation::ontime(void) const
{
return 1.0;
}
/***********************************************************************//**
* @brief Return livetime
*
* @return Livetime (always 1).
***************************************************************************/
inline
double GMWLObservation::livetime(void) const
{
return 1.0;
}
/***********************************************************************//**
* @brief Return deadtime correction factor
*
* @return Deadtime correction factor (always 1).
***************************************************************************/
inline
double GMWLObservation::deadc(const GTime& time) const
{
return 1.0;
}
/***********************************************************************//**
* @brief Return filename
*
* @return Filename.
***************************************************************************/
inline
const std::string& GMWLObservation::filename(void) const
{
return m_filename;
}
/***********************************************************************//**
* @brief Return extension number
*
* @return Extension number.
***************************************************************************/
inline
const std::string& GMWLObservation::extno(void) const
{
return m_extno;
}
/***********************************************************************//**
* @brief Return extension name
*
* @return Extension name.
***************************************************************************/
inline
const std::string& GMWLObservation::extname(void) const
{
return m_extname;
}
/***********************************************************************//**
* @brief Set filename
*
* @param[in] filename Filename.
***************************************************************************/
inline
void GMWLObservation::filename(const std::string& filename)
{
m_filename = filename;
return;
}
/***********************************************************************//**
* @brief Set extension number
*
* @param[in] extno Extension number.
***************************************************************************/
inline
void GMWLObservation::extno(const std::string& extno)
{
m_extno = extno;
return;
}
/***********************************************************************//**
* @brief Set extension name
*
* @param[in] extname Extension name..
***************************************************************************/
inline
void GMWLObservation::extname(const std::string& extname)
{
m_extname = extname;
return;
}
#endif /* GMWLOBSERVATION_HPP */