GObservationRegistry.hpp
4.94 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
/***************************************************************************
* GObservationRegistry.hpp - Observation registry class *
* ----------------------------------------------------------------------- *
* copyright (C) 2011-2014 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 GObservationRegistry.hpp
* @brief Observation registry class definition
* @author Juergen Knoedlseder
*/
#ifndef GOBSERVATIONREGISTRY_HPP
#define GOBSERVATIONREGISTRY_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GRegistry.hpp"
#include "GObservation.hpp"
/***********************************************************************//**
* @class GObservationRegistry
*
* @brief Interface definition for the observation registry class
*
* The registry class allows the registration of observations that are not
* necessarily compiled into the GammaLib. It uses the static members
* m_number, m_names, and m_obs which are allocated globally to keep track
* of observations that are available throughout all linked libraries. To
* register an observation it is sufficient to add
*
* const GXXXObservation g_obs_XXX_seed;
* const GObservationRegistry g_obs_XXX_registry(&g_obs_XXX_seed);
*
* at the top of the .cpp file of the observation. Here, XXX is a unique
* name that describes the instrument for which the observation class is
* implemented.
***************************************************************************/
class GObservationRegistry : public GRegistry {
public:
// Constructors and destructors
GObservationRegistry(void);
GObservationRegistry(const GObservation* obs);
GObservationRegistry(const GObservationRegistry& registry);
virtual ~GObservationRegistry(void);
// Operators
GObservationRegistry& operator= (const GObservationRegistry& registry);
// Methods
std::string classname(void) const;
int size(void) const;
GObservation* alloc(const std::string& name) const;
std::string name(const int& index) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GObservationRegistry& registry);
void free_members(void);
private:
// Private members (the private members have been implement as static
// methods to avoid the static initialization order fiasco of static
// members; using static methods we follow the "construct on first use
// idiom")
// Number of models in registry
static int& number() {
static int m_number = 0;
return m_number;
}
// Model names
static GRegistryPointer<std::string>& names() {
static GRegistryPointer<std::string> m_names;
return m_names;
}
// Pointer to seed models
static GRegistryPointer<const GObservation*>& obs() {
static GRegistryPointer<const GObservation*> m_obs;
return m_obs;
}
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GObservationRegistry").
***************************************************************************/
inline
std::string GObservationRegistry::classname(void) const
{
return ("GObservationRegistry");
}
/***********************************************************************//**
* @brief Return number of registered observations
*
* @return Number of registered observations.
*
* Returns the number of registered observations.
***************************************************************************/
inline
int GObservationRegistry::size(void) const
{
return number();
}
#endif /* GOBSERVATIONREGISTRY_HPP */