-
Notifications
You must be signed in to change notification settings - Fork 20
/
record.h
258 lines (188 loc) · 7.78 KB
/
record.h
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
258
/***************************************************************************
* Copyright (C) gempa GmbH *
* All rights reserved. *
* Contact: gempa GmbH (seiscomp-dev@gempa.de) *
* *
* GNU Affero General Public License Usage *
* This file may be used under the terms of the GNU Affero *
* Public License version 3.0 as published by the Free Software Foundation *
* and appearing in the file LICENSE included in the packaging of this *
* file. Please review the following information to ensure the GNU Affero *
* Public License version 3.0 requirements will be met: *
* https://www.gnu.org/licenses/agpl-3.0.html. *
* *
* Other Usage *
* Alternatively, this file may be used in accordance with the terms and *
* conditions contained in a signed written agreement between you and *
* gempa GmbH. *
***************************************************************************/
#ifndef SEISCOMP_CORE_RECORD_H
#define SEISCOMP_CORE_RECORD_H
#include <string>
#include <time.h>
#include <iostream>
#include <seiscomp/core/baseobject.h>
#include <seiscomp/core/interfacefactory.h>
#include <seiscomp/core/timewindow.h>
#include <seiscomp/core/array.h>
#include <seiscomp/core/exceptions.h>
namespace Seiscomp {
class BitSet;
DEFINE_SMARTPOINTER(Record);
class SC_SYSTEM_CORE_API Record : public Seiscomp::Core::BaseObject {
DECLARE_SC_CLASS(Record);
DECLARE_SERIALIZATION;
// ----------------------------------------------------------------------
// Public enumeration
// ----------------------------------------------------------------------
public:
//! Specifies the memory storage flags.
enum Hint {
META_ONLY,
DATA_ONLY,
SAVE_RAW,
H_QUANTITY
};
//! This enum was introduced with API 13
enum Authentication {
NOT_SIGNED,
SIGNATURE_VALIDATED,
SIGNATURE_VALIDATION_FAILED,
A_QUANTITY
};
// ----------------------------------------------------------------------
// X'truction
// ----------------------------------------------------------------------
public:
//! Default Constructor
Record(Array::DataType datatype, Hint);
//! Initializing Constructor
Record(Array::DataType, Hint,
std::string net, std::string sta, std::string loc, std::string cha,
Seiscomp::Core::Time stime, int nsamp, double fsamp, int tqual);
//! Copy Constructor
Record(const Record &rec);
//! Destructor
virtual ~Record();
// ----------------------------------------------------------------------
// Operators
// ----------------------------------------------------------------------
public:
//! Assignment operator
Record &operator=(const Record &rec);
// ----------------------------------------------------------------------
// Public attribute access
// ----------------------------------------------------------------------
public:
//! Returns the network code
const std::string &networkCode() const;
//! Sets the network code
virtual void setNetworkCode(std::string net);
//! Returns the station code
const std::string &stationCode() const;
//! Sets the station code
virtual void setStationCode(std::string sta);
//! Returns the location code
const std::string &locationCode() const;
//! Sets the location code
virtual void setLocationCode(std::string loc);
//! Returns the channel code
const std::string &channelCode() const;
//! Sets the channel code
virtual void setChannelCode(std::string cha);
//! Returns the start time
const Core::Time& startTime() const;
//! Sets the start time
virtual void setStartTime(const Core::Time& time);
//! Returns the end time
Core::Time endTime() const;
//! Returns the time window between start and end time of a record
Core::TimeWindow timeWindow() const;
//! Returns the sample number
int sampleCount() const;
//! Returns the sample frequency
double samplingFrequency() const;
//! Returns the timing quality
int timingQuality() const;
//! Sets the timing quality
void setTimingQuality(int tqual);
//! Returns the so called stream ID: <net>.<sta>.<loc>.<cha>
std::string streamID() const;
//! Returns the data type specified for the data sample requests
Array::DataType dataType() const;
//! Sets the data type for the data requests which can differ from the real type of the data samples
void setDataType(Array::DataType dt);
//! Sets the hint used for data operations
void setHint(Hint h);
/**
* @brief Sets the authentication state.
* This function was introduced with API 13.
* @param auth The authentication status
*/
void setAuthentication(Authentication auth);
//! This function was introduced with API 13
Authentication authentication() const;
/**
* @brief Sets the authentication authority
* This function was introduced with API 13.
* @param authority The authority which signed the record
*/
void setAuthority(const std::string &authority);
//! This function was introduced with API 13
const std::string &authority() const;
// ----------------------------------------------------------------------
// Public data access
// ----------------------------------------------------------------------
public:
//! Returns a nonmutable pointer to the data samples if the data is available; otherwise 0
//! (the data type is independent from the original one and was given by the DataType flag in the constructor)
virtual const Array* data() const = 0;
//! Returns the raw data of the record if existing
virtual const Array* raw() const = 0;
//! Returns a deep copy of the calling object.
virtual Record* copy() const = 0;
//! Return the clip mask for the data in the record. The clip mask
//! holds a bit for each sample and sets that bit to 1 if the sample
//! is clipped. The default implementation always returns nullptr.
//! Support has to be provided in derived implementations.
virtual const BitSet *clipMask() const;
// ----------------------------------------------------------------------
// Public methods
// ----------------------------------------------------------------------
public:
//! Frees the memory allocated for the data samples.
virtual void saveSpace() const = 0;
virtual void read(std::istream &in) = 0;
virtual void write(std::ostream &out) = 0;
// ----------------------------------------------------------------------
// Protected members
// ----------------------------------------------------------------------
protected:
std::string _net;
std::string _sta;
std::string _loc;
std::string _cha;
Core::Time _stime;
Array::DataType _datatype;
Hint _hint;
int _nsamp;
double _fsamp;
int _timequal;
Authentication _authenticationStatus;
std::string _authority;
};
DEFINE_INTERFACE_FACTORY(Record);
#define REGISTER_RECORD_VAR(Class, Service) \
Seiscomp::Core::Generic::InterfaceFactory<Seiscomp::Record, Class> __##Class##InterfaceFactory__(Service)
#define REGISTER_RECORD(Class, Service) \
static REGISTER_RECORD_VAR(Class, Service)
inline Record::Authentication Record::authentication() const {
return _authenticationStatus;
}
inline const std::string &Record::authority() const {
return _authority;
}
}
SC_SYSTEM_CORE_API std::istream& operator>>(std::istream &is, Seiscomp::Record &rec);
SC_SYSTEM_CORE_API std::ostream& operator<<(std::ostream &os, Seiscomp::Record &rec);
#endif