GEnergies.hpp
6.75 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
/***************************************************************************
* GEnergies.hpp - Energy container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013-2016 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 GEnergies.hpp
* @brief Energy container class definition
* @author Juergen Knoedlseder
*/
#ifndef GENERGIES_HPP
#define GENERGIES_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GContainer.hpp"
#include "GEnergy.hpp"
#include "GFits.hpp"
#include "GFitsTable.hpp"
/* __ Forward declarations _______________________________________________ */
class GFilename;
/***********************************************************************//**
* @class GEnergies
*
* @brief Energy container class.
*
* This class is a container for energies. Energies are implemented by the
* GEnergy class which stores energies in a unit independent way.
*
* An energy container can be constructed from a FITS file or by defining
* a number of energies within a given interval, spaced either linearly or
* logarithmically.
***************************************************************************/
class GEnergies : public GContainer {
public:
// Constructors and destructors
GEnergies(void);
explicit GEnergies(const GFilename& filename);
GEnergies(const GEnergies& energies);
GEnergies(const int& num, const GEnergy& emin, const GEnergy& emax,
const bool& log = true);
virtual ~GEnergies(void);
// Operators
GEnergies& operator=(const GEnergies& energies);
GEnergy& operator[](const int& index);
const GEnergy& operator[](const int& index) const;
// Methods
void clear(void);
GEnergies* clone(void) const;
std::string classname(void) const;
GEnergy& at(const int& index);
const GEnergy& at(const int& index) const;
int size(void) const;
bool is_empty(void) const;
GEnergy& append(const GEnergy& energy);
GEnergy& insert(const int& index, const GEnergy& energy);
void remove(const int& index);
void reserve(const int& num);
void extend(const GEnergies& energies);
void set_lin(const int& num, const GEnergy& emin,
const GEnergy& emax);
void set_log(const int& num, const GEnergy& emin,
const GEnergy& emax);
void load(const GFilename& filename);
void save(const GFilename& filename,
const bool& clobber = false) const;
void read(const GFitsTable& table);
void write(GFits& file,
const std::string& extname = "ENERGIES") const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GEnergies& energies);
void free_members(void);
// Protected data members
std::vector<GEnergy> m_energies; //!< List of energies
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GEnergies").
***************************************************************************/
inline
std::string GEnergies::classname(void) const
{
return ("GEnergies");
}
/***********************************************************************//**
* @brief Return reference to energy
*
* @param[in] index Energy index [0,...,size()-1].
*
* Returns a reference to the energy with the specified @p index.
***************************************************************************/
inline
GEnergy& GEnergies::operator[](const int& index)
{
return (m_energies[index]);
}
/***********************************************************************//**
* @brief Return reference to energy (const version)
*
* @param[in] index Energy index [0,...,size()-1].
*
* Returns a reference to the energy with the specified @p index.
***************************************************************************/
inline
const GEnergy& GEnergies::operator[](const int& index) const
{
return (m_energies[index]);
}
/***********************************************************************//**
* @brief Return number of energies in container
*
* @return Number of energies in container.
*
* Returns the number of energies in the energy container.
***************************************************************************/
inline
int GEnergies::size(void) const
{
return (int)m_energies.size();
}
/***********************************************************************//**
* @brief Signals if there are no energies in container
*
* @return True if container is empty, false otherwise.
*
* Signals if the energy container does not contain any energy.
***************************************************************************/
inline
bool GEnergies::is_empty(void) const
{
return (m_energies.empty());
}
/***********************************************************************//**
* @brief Reserves space for energies in container
*
* @param[in] num Number of energies.
*
* Reserves space for @p num energies in the container.
***************************************************************************/
inline
void GEnergies::reserve(const int& num)
{
m_energies.reserve(num);
return;
}
#endif /* GENERGIES_HPP */