Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
IndexedMzMLFile.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_INDEXEDMZMLFILE_H
36 #define OPENMS_FORMAT_INDEXEDMZMLFILE_H
37 
38 #include <OpenMS/config.h>
39 #include <OpenMS/CONCEPT/Types.h>
43 
44 #include <string>
45 #include <fstream>
46 
47 namespace OpenMS
48 {
49 
74  class OPENMS_DLLAPI IndexedMzMLFile
75  {
79  std::vector< std::pair<std::string, std::streampos> > spectra_offsets_;
81  std::vector< std::pair<std::string, std::streampos> > chromatograms_offsets_;
83  std::streampos index_offset_;
87  std::ifstream filestream_;
92 
101  void parseFooter_(String filename);
102 
103  public:
104 
108  IndexedMzMLFile();
109 
115  explicit IndexedMzMLFile(String filename);
116 
118  IndexedMzMLFile(const IndexedMzMLFile & source);
119 
121  ~IndexedMzMLFile();
122 
128  void openFile(String filename);
129 
139  bool getParsingSuccess() const;
140 
142  size_t getNrSpectra() const;
143 
145  size_t getNrChromatograms() const;
146 
155  OpenMS::Interfaces::SpectrumPtr getSpectrumById(int id);
156 
165  OpenMS::Interfaces::ChromatogramPtr getChromatogramById(int id);
166 
168  void setSkipXMLChecks(bool skip)
169  {
170  skip_xml_checks_ = skip;
171  }
172 
173  };
174 }
175 
176 #endif // OPENMS_FORMAT_INDEXEDMZMLFILE_H
177 
boost::shared_ptr< Spectrum > SpectrumPtr
Definition: openms/include/OpenMS/INTERFACES/DataStructures.h:237
bool parsing_success_
Whether parsing the indexedmzML file was successful.
Definition: IndexedMzMLFile.h:89
void setSkipXMLChecks(bool skip)
Whether to skip some XML checks (removing whitespace from base64 arrays) and be fast instead...
Definition: IndexedMzMLFile.h:168
boost::shared_ptr< Chromatogram > ChromatogramPtr
Definition: openms/include/OpenMS/INTERFACES/DataStructures.h:157
A more convenient string class.
Definition: String.h:57
bool skip_xml_checks_
Whether to skip XML checks.
Definition: IndexedMzMLFile.h:91
bool spectra_before_chroms_
Whether spectra are written before chromatograms in this file.
Definition: IndexedMzMLFile.h:85
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
A low-level class to read an indexedmzML file.
Definition: IndexedMzMLFile.h:74
std::streampos index_offset_
offset to the <indexList> element
Definition: IndexedMzMLFile.h:83
std::ifstream filestream_
The current filestream (opened by openFile)
Definition: IndexedMzMLFile.h:87
std::vector< std::pair< std::string, std::streampos > > spectra_offsets_
Binary offsets to all spectra.
Definition: IndexedMzMLFile.h:79
std::vector< std::pair< std::string, std::streampos > > chromatograms_offsets_
Binary offsets to all chromatograms.
Definition: IndexedMzMLFile.h:81
String filename_
Name of the file.
Definition: IndexedMzMLFile.h:77

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