GSource.hpp
6.61 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
/***************************************************************************
* GSource.hpp - Source class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-2013 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 GSource.hpp
* @brief Source class definition
* @author Juergen Knoedlseder
*/
#ifndef GSOURCE_HPP
#define GSOURCE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GModelSpatial.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
/***********************************************************************//**
* @class GSource
*
* @brief Class that handles gamma-ray sources
*
* The GSource class stores the physical attributes of a gamma-ray source,
* which is the distribution of photon arrival directions in form of a
* spatial source model, the photon energy, and the photon arrival time.
* The class is very similar to the GPhoton class, yet instead of a given
* photon arrival direction it contains a spatial model pointer. Note that
* the class does not allocate or deallocate the spatial model pointer,
* it just is a carrier of a pointer which is handled outside the class.
*
* Each source also has a name so that it can be identified.
***************************************************************************/
class GSource : public GBase {
public:
// Constructors and destructors
GSource(void);
explicit GSource(const std::string& name,
GModelSpatial* model,
const GEnergy& energy,
const GTime& time);
GSource(const GSource& src);
virtual ~GSource(void);
// Operators
GSource& operator=(const GSource& src);
// Methods
void clear(void);
GSource* clone(void) const;
const std::string& name(void) const;
const GModelSpatial* model(void) const;
const GEnergy& energy(void) const;
const GTime& time(void) const;
void name(const std::string& name);
void model(GModelSpatial* model);
void energy(const GEnergy& energy);
void time(const GTime& time);
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GSource& src);
void free_members(void);
// Protected data members
std::string m_name; //!< Source name
GModelSpatial* m_model; //!< Spatial model
GEnergy m_energy; //!< Photon energy
GTime m_time; //!< Photon arrival time
};
/***********************************************************************//**
* @brief Return model name
*
* @return Model name.
*
* Returns the model name.
***************************************************************************/
inline
const std::string& GSource::name(void) const
{
return m_name;
}
/***********************************************************************//**
* @brief Return spatial model component
*
* @return Pointer to spatial model component.
*
* Returns spatial model component.
***************************************************************************/
inline
const GModelSpatial* GSource::model(void) const
{
return m_model;
}
/***********************************************************************//**
* @brief Return photon energy
*
* @return Photon energy.
*
* Returns photon energy.
***************************************************************************/
inline
const GEnergy& GSource::energy(void) const
{
return m_energy;
}
/***********************************************************************//**
* @brief Return photon arrival time
*
* @return Photon arrival time.
*
* Returns the photon arrival time.
***************************************************************************/
inline
const GTime& GSource::time(void) const
{
return m_time;
}
/***********************************************************************//**
* @brief Set model name
*
* @param[in] name Model name.
*
* Sets the model name.
***************************************************************************/
inline
void GSource::name(const std::string& name)
{
m_name = name;
return;
}
/***********************************************************************//**
* @brief Set spatial model component
*
* @param[in] model Spatial model component.
*
* Sets the spatial model component.
***************************************************************************/
inline
void GSource::model(GModelSpatial* model)
{
m_model = model;
return;
}
/***********************************************************************//**
* @brief Set photon energy
*
* @param[in] energy Photon energy.
*
* Sets the photon energy.
***************************************************************************/
inline
void GSource::energy(const GEnergy& energy)
{
m_energy = energy;
return;
}
/***********************************************************************//**
* @brief Set photon arrival time
*
* @param[in] time Photon arrival time.
*
* Sets the photon arrival time.
***************************************************************************/
inline
void GSource::time(const GTime& time)
{
m_time = time;
return;
}
#endif /* GSOURCE_HPP */