Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MzMLSpectrumDecoder.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_HANDLERS_MZMLSPECTRUMDECODER_H
36 #define OPENMS_FORMAT_HANDLERS_MZMLSPECTRUMDECODER_H
37 
38 #include <OpenMS/config.h>
39 #include <OpenMS/CONCEPT/Types.h>
42 #include <OpenMS/FORMAT/Base64.h>
45 
46 #include <string>
47 #include <xercesc/dom/DOMNode.hpp>
48 
50 
51 namespace OpenMS
52 {
53 
64  class OPENMS_DLLAPI MzMLSpectrumDecoder
65  {
66  protected:
67 
69 
71 
79  OpenMS::Interfaces::SpectrumPtr decodeBinaryDataSpectrum_(std::vector<BinaryData> & data_);
80 
88  OpenMS::Interfaces::ChromatogramPtr decodeBinaryDataChrom_(std::vector<BinaryData> & data_);
89 
100  void handleBinaryDataArray_(xercesc::DOMNode * indexListNode, std::vector<BinaryData>& data_);
101 
117  void domParseString_(const std::string& in, std::vector<BinaryData>& data_);
118 
119  public:
120 
122  skip_xml_checks_(false)
123  {}
124 
125 
126 
140  void domParseSpectrum(const std::string& in, OpenMS::Interfaces::SpectrumPtr & sptr);
141 
155  void domParseChromatogram(const std::string& in, OpenMS::Interfaces::ChromatogramPtr & cptr);
156 
158  void setSkipXMLChecks(bool only);
159  };
160 }
161 
162 #endif // OPENMS_FORMAT_HANDLERS_MZMLSPECTRUMDECODER_H
163 
boost::shared_ptr< Spectrum > SpectrumPtr
Definition: openms/include/OpenMS/INTERFACES/DataStructures.h:237
boost::shared_ptr< Chromatogram > ChromatogramPtr
Definition: openms/include/OpenMS/INTERFACES/DataStructures.h:157
Binary data representation.
Definition: MzMLHandlerHelper.h:58
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
bool skip_xml_checks_
Definition: MzMLSpectrumDecoder.h:68
MzMLSpectrumDecoder()
Definition: MzMLSpectrumDecoder.h:121
A class to decode input strings that contain an mzML chromatogram or spectrum tag.
Definition: MzMLSpectrumDecoder.h:64
Internal::MzMLHandlerHelper::BinaryData BinaryData
Definition: MzMLSpectrumDecoder.h:70

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:02 using doxygen 1.8.13