GPhoton.hpp
4.2 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
/***************************************************************************
* GPhoton.hpp - Photon class *
* ----------------------------------------------------------------------- *
* copyright (C) 2011-2012 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 GPhoton.hpp
* @brief Photon class definition.
* @author Juergen Knoedlseder
*/
#ifndef GPHOTON_HPP
#define GPHOTON_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GSkyDir.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
/***********************************************************************//**
* @class GPhoton
*
* @brief Class that handles photons.
*
* The GPhoton class stores the physical attributes of a photon such as the
* photon arrival direction, its energy and its arrival time. This class is
* mainly used for Monte Carlo simulations.
***************************************************************************/
class GPhoton : public GBase {
// Operator friends
friend bool operator==(const GPhoton &a, const GPhoton &b);
friend bool operator!=(const GPhoton &a, const GPhoton &b);
public:
// Constructors and destructors
GPhoton(void);
explicit GPhoton(const GSkyDir& dir, const GEnergy& energy, const GTime& time);
GPhoton(const GPhoton& ph);
virtual ~GPhoton(void);
// Operators
GPhoton& operator=(const GPhoton& ph);
// Methods
void clear(void);
GPhoton* clone(void) const;
const GSkyDir& dir(void) const { return m_dir; }
const GEnergy& energy(void) const { return m_energy; }
const GTime& time(void) const { return m_time; }
const int& mcid(void) const { return m_mc_id; }
void dir(const GSkyDir& dir) { m_dir=dir; }
void energy(const GEnergy& energy) { m_energy=energy; }
void time(const GTime& time) { m_time=time; }
void mcid(const int& mcid) { m_mc_id=mcid; }
std::string print(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GPhoton& ph);
void free_members(void);
// Protected data members
GSkyDir m_dir; //!< Photon arrival direction
GEnergy m_energy; //!< Photon energy
GTime m_time; //!< Photon arrival time
int m_mc_id; //!< Monte Carlo simulation origin
};
/***************************************************************************
* Inline friends *
***************************************************************************/
inline
bool operator== (const GPhoton &a, const GPhoton &b)
{
return (a.m_energy == b.m_energy && a.m_time == b.m_time &&
a.m_dir.dist(b.m_dir) == 0.0);
}
inline
bool operator!= (const GPhoton &a, const GPhoton &b)
{
return (a.m_energy != b.m_energy || a.m_time != b.m_time ||
a.m_dir.dist(b.m_dir) > 0.0);
}
#endif /* GPHOTON_HPP */