GCTAEventAtom.hpp
7.45 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
/***************************************************************************
* GCTAEventAtom.hpp - CTA event atom 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 GCTAEventAtom.hpp
* @brief CTA event atom class definition
* @author Juergen Knoedlseder
*/
#ifndef GCTAEVENTATOM_HPP
#define GCTAEVENTATOM_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GEventAtom.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GCTAInstDir.hpp"
/***********************************************************************//**
* @class GCTAEventAtom
*
* @brief CTA event atom class
*
* This class implements a CTA event atom. It collects all the relevant event
* information needed for CTA unbinned analysis.
***************************************************************************/
class GCTAEventAtom : public GEventAtom {
// Friend classes
friend class GCTAEventList;
public:
// Constructors and destructors
GCTAEventAtom(void);
GCTAEventAtom(const GCTAEventAtom& atom);
virtual ~GCTAEventAtom(void);
// Operators
GCTAEventAtom& operator=(const GCTAEventAtom& atom);
// Implemented pure virtual base class methods
void clear(void);
GCTAEventAtom* clone(void) const;
std::string classname(void) const;
const GCTAInstDir& dir(void) const;
const GEnergy& energy(void) const;
const GTime& time(void) const;
void dir(const GCTAInstDir& dir);
void energy(const GEnergy& energy);
void time(const GTime& time);
std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
const int& index(void) const;
const unsigned long& event_id(void) const;
const float& phase(void) const;
void event_id(const unsigned long& id);
void phase(const float& phase);
protected:
// Protected methods
void init_members(void);
void copy_members(const GCTAEventAtom& atom);
void free_members(void);
// Protected members
int m_index; //!< Index in list
GCTAInstDir m_dir; //!< Event direction
GEnergy m_energy; //!< Event energy
GTime m_time; //!< Event time
unsigned long m_event_id; //!< Event identifier
float m_phase; //!< Optional phase
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GCTAEventAtom").
***************************************************************************/
inline
std::string GCTAEventAtom::classname(void) const
{
return ("GCTAEventAtom");
}
/***********************************************************************//**
* @brief Return instrument direction
*
* @return Instrument direction.
***************************************************************************/
inline
const GCTAInstDir& GCTAEventAtom::dir(void) const
{
return (m_dir);
}
/***********************************************************************//**
* @brief Return energy
*
* @return Energy.
***************************************************************************/
inline
const GEnergy& GCTAEventAtom::energy(void) const
{
return (m_energy);
}
/***********************************************************************//**
* @brief Return time
*
* @return Time.
***************************************************************************/
inline
const GTime& GCTAEventAtom::time(void) const
{
return (m_time);
}
/***********************************************************************//**
* @brief Set instrument direction
*
* @param[in] dir Instrument direction.
***************************************************************************/
inline
void GCTAEventAtom::dir(const GCTAInstDir& dir)
{
m_dir = dir;
return;
}
/***********************************************************************//**
* @brief Set energy
*
* @param[in] energy Energy.
***************************************************************************/
inline
void GCTAEventAtom::energy(const GEnergy& energy)
{
m_energy = energy;
return;
}
/***********************************************************************//**
* @brief Set time
*
* @param[in] time Time.
***************************************************************************/
inline
void GCTAEventAtom::time(const GTime& time)
{
m_time = time;
return;
}
/***********************************************************************//**
* @brief Return event index in list
*
* @return Index.
*
* Returns the index of the event in case it is part of a list.
***************************************************************************/
inline
const int& GCTAEventAtom::index(void) const
{
return (m_index);
}
/***********************************************************************//**
* @brief Return event identifier
*
* @return Event identifier.
***************************************************************************/
inline
const unsigned long& GCTAEventAtom::event_id(void) const
{
return (m_event_id);
}
/***********************************************************************//**
* @brief Return event phase
*
* @return Event phase.
***************************************************************************/
inline
const float& GCTAEventAtom::phase(void) const
{
return (m_phase);
}
/***********************************************************************//**
* @brief Set event identifier
*
* @param[in] id Event identifier.
***************************************************************************/
inline
void GCTAEventAtom::event_id(const unsigned long& id)
{
m_event_id = id;
return;
}
/***********************************************************************//**
* @brief Set event phase
*
* @param[in] phase Event phase.
***************************************************************************/
inline
void GCTAEventAtom::phase(const float& phase)
{
m_phase = phase;
return;
}
#endif /* GCTAEVENTATOM_HPP */