Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_umod_neutralloss.hpp
1/*
2##############################################################################
3# file: ms_umod_neutralloss.hpp #
4# 'msparser' toolkit #
5# Represents 'NeutralLoss' element in unimod.xml file #
6##############################################################################
7# COPYRIGHT NOTICE #
8# Copyright 1998-2006 Matrix Science Limited All Rights Reserved. #
9# #
10##############################################################################
11 * @(#)$Source: parser/inc/ms_umod_neutralloss.hpp $
12 * @(#)$Revision: 0bb105c754f1d83ce7437808601186f321028555 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
13 * @(#)$Date: 2019-04-17 12:17:44 +0100 $
14##############################################################################
15 */
16
17#ifndef MS_UMOD_NEUTRALLOSS_HPP
18#define MS_UMOD_NEUTRALLOSS_HPP
19
20
21#include <string>
22#include <vector>
23
24// forward declarations
25namespace msparser_internal {
26 class ms_umod_xmlloader;
27}
28
29namespace matrix_science {
30
31 class ms_quant_neutralloss; // forward declaration
32 class ms_quant_pepneutralloss; // forward declaration
33 class ms_umod_configfile;
34 class ms_xml_schema; // forward declaration
35
42
47 class MS_MASCOTRESFILE_API ms_umod_neutralloss: public ms_umod_composition
48 {
49 friend class msparser_internal::ms_umod_xmlloader;
50
51 public:
54
57
60
63
65 virtual ~ms_umod_neutralloss();
66
68 void defaultValues();
69
71 void copyFrom(const ms_umod_neutralloss* right);
72
74 void copyFrom(const ms_quant_neutralloss* right, const ms_umod_configfile& umodFile);
75
77 void copyFrom(const ms_quant_pepneutralloss* right, const ms_umod_configfile& umodFile);
78
79#ifndef SWIG
81 ms_umod_neutralloss& operator=(const ms_umod_neutralloss& right);
82#endif
84 virtual std::string getSchemaType() const;
85
87 virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
88
90 virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
91
92
94 bool haveFlag() const;
95
97 bool isFlag() const;
98
100 void setFlag(const bool value);
101
103 void dropFlag();
104
106 std::string getFlagSchemaType() const;
107
108
110 bool haveCode() const;
111
113 std::string getCode() const;
114
116 void setCode(const char* value);
117
119 void dropCode();
120
122 std::string getCodeSchemaType() const;
123
124
126 bool havePairsWith() const;
127
129 std::string getPairsWith() const;
130
132 void setPairsWith(const char* value);
133
135 void dropPairsWith();
136
138 std::string getPairsWithSchemaType() const;
139
140
142 bool haveDescription() const;
143
145 std::string getDescription() const;
146
148 void setDescription(const char* value);
149
151 void dropDescription();
152
154 std::string getDescriptionSchemaType() const;
155
156 private:
157
158 bool _flag;
159 bool _flag_set;
160
161 std::string _code;
162 bool _code_set;
163
164 std::string _pairsWith;
165 bool _pairsWith_set;
166
167 std::string _description;
168 bool _description_set;
169 }; // class ms_umod_neutralloss
170 // end of config_group
172
173} // namespace matrix_science
174
175#endif // MS_UMOD_NEUTRALLOSS_HPP
176
177/*------------------------------- End of File -------------------------------*/
A neutral loss for the sequence ions, e.g. loss of phosphate.
Definition: ms_quant_neutralloss.hpp:37
A neutral loss from the precursor.
Definition: ms_quant_pepneutralloss.hpp:37
Represents the composition type in unimod.xml.
Definition: ms_umod_composition.hpp:48
This class represents the file unimod.xml.
Definition: ms_umod_configfile.hpp:54
Represents NeutralLoss and PepNeutralLoss objects in unimod.xml.
Definition: ms_umod_neutralloss.hpp:48