Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_quant_protocol.hpp
1/*
2##############################################################################
3# file: ms_quant_protocol.hpp #
4# 'msparser' toolkit #
5# Encapsulates protocol-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_protocol.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_PROTOCOL_HPP
18#define MS_QUANT_PROTOCOL_HPP
19
20
21#include <string>
22
23// forward declarations
24namespace msparser_internal {
25 class ms_quant_xmlloader;
26 class ms_quant_protocol_impl;
27 class ms_quant_method_impl;
28}
29
30namespace matrix_science {
31
32 // forward declarations
33 class ms_quant_parameters;
34 class ms_quant_reporter;
35 class ms_quant_precursor;
36 class ms_quant_replicate;
37 class ms_quant_average;
38 class ms_quant_multiplex;
39 class ms_xml_schema;
40
47
54 class MS_MASCOTRESFILE_API ms_quant_protocol: public ms_xml_IValidatable
55 {
56 friend class msparser_internal::ms_quant_xmlloader;
57 friend class msparser_internal::ms_quant_method_impl;
58 public:
61
64
66 virtual ~ms_quant_protocol();
67
69 void defaultValues();
70
72 void copyFrom(const ms_quant_protocol* right);
73
74#ifndef SWIG
76 ms_quant_protocol& operator=(const ms_quant_protocol& right);
77#endif
79 virtual std::string getSchemaType() const;
80
82 virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
83
85 virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
86
87
89 std::string getType() const;
90
92 void setNull();
93
94
96 const ms_quant_reporter* getReporter() const;
97
99 void setReporter(const ms_quant_reporter* reporter);
100
102 std::string getReporterSchemaType() const;
103
104
106 const ms_quant_precursor* getPrecursor() const;
107
109 void setPrecursor(const ms_quant_precursor* precursor);
110
112 std::string getPrecursorSchemaType() const;
113
114
116 const ms_quant_multiplex* getMultiplex() const;
117
119 void setMultiplex(const ms_quant_multiplex* multiplex);
120
122 std::string getMultiplexSchemaType() const;
123
124
126 const ms_quant_replicate* getReplicate() const;
127
129 void setReplicate(const ms_quant_replicate* replicate);
130
132 std::string getReplicateSchemaType() const;
133
134
136 const ms_quant_average* getAverage() const;
137
139 void setAverage(const ms_quant_average* average);
140
142 std::string getAverageSchemaType() const;
143
144 private:
145
146 msparser_internal::ms_quant_protocol_impl * m_pImpl;
147
148 }; // class ms_quant_protocol
149 // end of config_group
151
152} // namespace matrix_science
153
154#endif // MS_QUANT_PROTOCOL_HPP
155
156/*------------------------------- End of File -------------------------------*/
An object of this class represent a single "average" element in quantitation.xml.
Definition: ms_quant_average.hpp:40
An object of this class represent a multiplex element in quantitation.xml.
Definition: ms_quant_multiplex.hpp:40
An object of this class represent a single precursor element in quantitation.xml.
Definition: ms_quant_precursor.hpp:43
An object of this class represent a protocol element in quantitation.xml.
Definition: ms_quant_protocol.hpp:55
An object of this class represent a single replicate element in quantitation.xml.
Definition: ms_quant_replicate.hpp:40
An object of this class represents a single reporter element in quantitation.xml.
Definition: ms_quant_reporter.hpp:40