GXXXRoi.cpp
8.26 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
246
247
248
249
250
251
252
253
254
255
256
257
/***************************************************************************
* GXXXRoi.cpp - [INSTRUMENT] region of interest class *
* ----------------------------------------------------------------------- *
* copyright (C) [YEAR] by [AUTHOR] *
* ----------------------------------------------------------------------- *
* *
* 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 GXXXRoi.cpp
* @brief [INSTRUMENT] region of interest class implementation
* @author [AUTHOR]
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GXXXRoi.hpp"
/* __ Method name definitions ____________________________________________ */
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GXXXRoi::GXXXRoi(void) : GRoi()
{
// Initialise class members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] roi [INSTRUMENT] region of interest.
***************************************************************************/
GXXXRoi::GXXXRoi(const GXXXRoi& roi) : GRoi(roi)
{
// Initialise class members
init_members();
// Copy members
copy_members(roi);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GXXXRoi::~GXXXRoi(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] roi [INSTRUMENT] region of interest.
* @return [INSTRUMENT] region of interest.
***************************************************************************/
GXXXRoi& GXXXRoi::operator=(const GXXXRoi& roi)
{
// Execute only if object is not identical
if (this != &roi) {
// Copy base class members
this->GRoi::operator=(roi);
// Free members
free_members();
// Initialise private members
init_members();
// Copy members
copy_members(roi);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear region of interest
***************************************************************************/
void GXXXRoi::clear(void)
{
// Free members
free_members();
this->GRoi::free_members();
// Initialise private members
this->GRoi::init_members();
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone region of interest
*
* @return Pointer to deep copy of [INSTRUMENT] region of interest.
***************************************************************************/
GXXXRoi* GXXXRoi::clone(void) const
{
return new GXXXRoi(*this);
}
/***********************************************************************//**
* @brief Check if region of interest contains an event
*
* @return True if region of interest contains event, false otherwise.
*
* @todo Implement method.
***************************************************************************/
bool GXXXRoi::contains(const GEvent& event) const
{
// Initialise flag to non-containment
bool contains = false;
// TODO: Implement containment test
// Return containment flag
return contains;
}
/***********************************************************************//**
* @brief Print region of interest information
*
* @param[in] chatter Chattiness.
* @return String containing region of interest information.
*
* @todo Implement method.
***************************************************************************/
std::string GXXXRoi::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append header
result.append("=== GXXXRoi ===");
// Append information
// TODO: Add any relevant information
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GXXXRoi::init_members(void)
{
// Initialise members
// TODO: Initialise all data members
// Example:
double m_radius = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] roi [INSTRUMENT] region of interest.
***************************************************************************/
void GXXXRoi::copy_members(const GXXXRoi& roi)
{
// Copy attributes
// TODO: Copy all data members
// Example:
m_radius = roi.m_radius;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GXXXRoi::free_members(void)
{
// Return
return;
}