GPulsar.hpp
6.76 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
/***************************************************************************
* GPulsar.hpp - Pulsar class *
* ----------------------------------------------------------------------- *
* copyright (C) 2022 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 GPulsar.hpp
* @brief Pulsar class definition
* @author Juergen Knoedlseder
*/
#ifndef GPULSAR_HPP
#define GPULSAR_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBase.hpp"
#include "GPulsarEphemeris.hpp"
/* __ Forward declarations _______________________________________________ */
class GTime;
class GGti;
class GFilename;
class GFitsTable;
/* __ Constants __________________________________________________________ */
/***********************************************************************//**
* @class GPulsar
*
* @brief Pulsar class
*
* This class implements a pulsar, defined by a name and a list of pulsar
* ephemerides.
***************************************************************************/
class GPulsar : public GBase {
public:
// Constructors and destructors
GPulsar(void);
GPulsar(const GFilename& filename, const std::string& name = "");
GPulsar(const GPulsar& pulsar);
virtual ~GPulsar(void);
// Operators
GPulsar& operator=(const GPulsar& pulsar);
GPulsarEphemeris& operator[](const int& index);
const GPulsarEphemeris& operator[](const int& index) const;
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GPulsar* clone(void) const;
virtual std::string classname(void) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
int size(void) const;
bool is_empty(void) const;
GPulsarEphemeris& at(const int& index);
const GPulsarEphemeris& at(const int& index) const;
const std::string& name(void) const;
void name(const std::string& name);
const GPulsarEphemeris& ephemeris(const GTime& time) const;
GGti validity(void) const;
void load(const GFilename& filename,
const std::string& name = "");
protected:
// Protected methods
void init_members(void);
void copy_members(const GPulsar& pulsar);
void free_members(void);
void load_fits(const GFilename& filename, const std::string& name = "");
void load_integral(const GFitsTable* table, const std::string& name = "");
void load_fermi(const GFitsTable* table, const std::string& name = "");
void load_psrtime(const GFilename& filename, const std::string& name = "");
void load_parfile(const GFilename& filename);
// Protected members
std::string m_name; //!< Pulsar name
std::vector<GPulsarEphemeris> m_ephemerides; //!< Pulsar ephemerides
};
/***********************************************************************//**
* @brief Return reference to ephemeris
*
* @param[in] index Ephemeris index [0,...,size()-1].
*
* Returns a reference to the ephemeris with the specified @p index.
***************************************************************************/
inline
GPulsarEphemeris& GPulsar::operator[](const int& index)
{
return (m_ephemerides[index]);
}
/***********************************************************************//**
* @brief Return reference to ephemeris (const version)
*
* @param[in] index Ephemeris index [0,...,size()-1].
*
* Returns a const reference to the ephemeris with the specified @p index.
***************************************************************************/
inline
const GPulsarEphemeris& GPulsar::operator[](const int& index) const
{
return (m_ephemerides[index]);
}
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GPulsar").
***************************************************************************/
inline
std::string GPulsar::classname(void) const
{
return ("GPulsar");
}
/***********************************************************************//**
* @brief Return number of ephemerides for pulsar
*
* @return Number of ephemerides for pulsar.
*
* Returns the number of ephemerides for pulsar.
***************************************************************************/
inline
int GPulsar::size(void) const
{
return (int)m_ephemerides.size();
}
/***********************************************************************//**
* @brief Signals if there are no ephemerides for pulsar
*
* @return True if there are no ephemerides for pulsar, false otherwise.
*
* Signals if there are no ephemerides for pulsar.
***************************************************************************/
inline
bool GPulsar::is_empty(void) const
{
return (m_ephemerides.empty());
}
/***********************************************************************//**
* @brief Return pulsar name
*
* @return Pulsar name
***************************************************************************/
inline
const std::string& GPulsar::name(void) const
{
return (m_name);
}
/***********************************************************************//**
* @brief Set pulsar name
*
* @param[in] name Pulsar name.
***************************************************************************/
inline
void GPulsar::name(const std::string& name)
{
m_name = name;
return;
}
#endif /* GPULSAR_HPP */