Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_quant_integration.hpp
1/*
2##############################################################################
3# file: ms_quant_integration.hpp #
4# 'msparser' toolkit #
5# Encapsulates integration-element from "quantitation.xml"-file #
6##############################################################################
7# COPYRIGHT NOTICE #
8# Copyright 1998-2006 Matrix Science Limited All Rights Reserved. #
9# #
10##############################################################################
11 * @(#)$Source: parser/inc/ms_quant_integration.hpp $
12 * @(#)$Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
13 * @(#)$Date: 2018-07-30 16:23:53 +0100 $
14##############################################################################
15 */
16
17#ifndef MS_QUANT_INTEGRATION_HPP
18#define MS_QUANT_INTEGRATION_HPP
19
20
21#include <string>
22#include <vector>
23
24// forward declarations
25namespace msparser_internal {
26 class ms_quant_xmlloader;
27 class ms_quant_integration_impl;
28}
29
30
31namespace matrix_science {
32
33 class ms_xml_schema; // forward declaration
34
41
45 class MS_MASCOTRESFILE_API ms_quant_integration: public ms_quant_parameters
46 {
47 friend class msparser_internal::ms_quant_xmlloader;
48 public:
51
54
56 virtual ~ms_quant_integration();
57
59 void defaultValues();
60
62 void copyFrom(const ms_quant_integration* right);
63
64#ifndef SWIG
66 ms_quant_integration& operator=(const ms_quant_integration& right);
67#endif
69 virtual std::string getSchemaType() const;
70
72 virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
73
75 virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
76
77
79 bool haveMethod() const;
80
82 std::string getMethod() const;
83
85 void setMethod(const char* value);
86
88 void dropMethod();
89
91 std::string getMethodSchemaType() const;
92
93
95 bool haveSource() const;
96
98 std::string getSource() const;
99
101 void setSource(const char* value);
102
104 void dropSource();
105
107 std::string getSourceSchemaType() const;
108
109
111 bool haveMassDelta() const;
112
114 std::string getMassDelta() const;
115
117 void setMassDelta(const char* value);
118
120 void dropMassDelta();
121
123 std::string getMassDeltaSchemaType() const;
124
125
127 bool haveMassDeltaUnit() const;
128
130 std::string getMassDeltaUnit() const;
131
133 void setMassDeltaUnit(const char* value);
134
136 void dropMassDeltaUnit();
137
139 std::string getMassDeltaUnitSchemaType() const;
140
141
143 bool haveElutionTimeDelta() const;
144
146 std::string getElutionTimeDelta() const;
147
149 void setElutionTimeDelta(const char* value);
150
152 void dropElutionTimeDelta();
153
155 std::string getElutionTimeDeltaSchemaType() const;
156
157
159 bool haveElutionTimeDeltaUnit() const;
160
162 std::string getElutionTimeDeltaUnit() const;
163
165 void setElutionTimeDeltaUnit(const char* value);
166
168 void dropElutionTimeDeltaUnit();
169
171 std::string getElutionTimeDeltaUnitSchemaType() const;
172
173
175 bool haveElutionProfileCorrelationThreshold() const;
176
178 std::string getElutionProfileCorrelationThreshold() const;
179
181 void setElutionProfileCorrelationThreshold(const char* value);
182
184 void dropElutionProfileCorrelationThreshold();
185
187 std::string getElutionProfileCorrelationThresholdSchemaType() const;
188
189
191 bool haveProcessingOptions() const;
192
194 std::string getProcessingOptions() const;
195
197 void setProcessingOptions(const std::string value);
198
200 void dropProcessingOptions();
201
203 std::string getProcessingOptionsSchemaType() const;
204
205
207 bool havePrecursorRange() const;
208
210 std::string getPrecursorRange() const;
211
213 void setPrecursorRange(const char* value);
214
216 void dropPrecursorRange();
217
219 std::string getPrecursorRangeSchemaType() const;
220
221
223 bool haveMatchedRho() const;
224
226 std::string getMatchedRho() const;
227
229 void setMatchedRho(const char * value);
230
232 void dropMatchedRho();
233
235 std::string getMatchedRhoSchemaType() const;
236
237
239 bool haveXicThreshold() const;
240
242 std::string getXicThreshold() const;
243
245 void setXicThreshold(const char * value);
246
248 void dropXicThreshold();
249
251 std::string getXicThresholdSchemaType() const;
252
253
255 bool haveXicMaxWidth() const;
256
258 int getXicMaxWidth() const;
259
261 void setXicMaxWidth(int value);
262
264 void dropXicMaxWidth();
265
267 std::string getXicMaxWidthSchemaType() const;
268
269
271 bool haveXicSmoothing() const;
272
274 int getXicSmoothing() const;
275
277 void setXicSmoothing(int value);
278
280 void dropXicSmoothing();
281
283 std::string getXicSmoothingSchemaType() const;
284
285
287 bool haveAllChargeStates() const;
288
290 bool isAllChargeStates() const;
291
293 void setAllChargeStates(const bool value);
294
296 void dropAllChargeStates();
297
299 std::string getAllChargeStatesSchemaType() const;
300
301
303 bool haveSimpleRatio() const;
304
306 bool isSimpleRatio() const;
307
309 void setSimpleRatio(const bool value);
310
312 void dropSimpleRatio();
313
315 std::string getSimpleRatioSchemaType() const;
316
317
319 bool haveAllChargeStatesThreshold() const;
320
322 std::string getAllChargeStatesThreshold() const;
323
325 void setAllChargeStatesThreshold(const char * value);
326
328 void dropAllChargeStatesThreshold();
329
331 std::string getAllChargeStatesThresholdSchemaType() const;
332
333
335 bool haveAllowElutionShift() const;
336
338 bool isAllowElutionShift() const;
339
341 void setAllowElutionShift(const bool value);
342
344 void dropAllowElutionShift();
345
347 std::string getAllowElutionShiftSchemaType() const;
348
349 private:
350 msparser_internal::ms_quant_integration_impl *m_pImpl;
351 }; // class ms_quant_integration
352 // end of config_group
354
355} // namespace matrix_science
356
357#endif // MS_QUANT_INTEGRATION_HPP
358
359/*------------------------------- End of File -------------------------------*/
360
An object of this class represent a single integration element in quantitation.xml.
Definition: ms_quant_integration.hpp:46
A class that represents base parametersType in quantitation.xml.
Definition: ms_quant_parameters.hpp:82