ProteoWizard
SpectrumList_mzXML.hpp
Go to the documentation of this file.
1//
2// $Id$
3//
4//
5// Original author: Darren Kessner <darren@proteowizard.org>
6//
7// Copyright 2008 Spielberg Family Center for Applied Proteomics
8// Cedars-Sinai Medical Center, Los Angeles, California 90048
9//
10// Licensed under the Apache License, Version 2.0 (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14// http://www.apache.org/licenses/LICENSE-2.0
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21//
22
23
24#ifndef _SPECTRUMLIST_MZXML_HPP_
25#define _SPECTRUMLIST_MZXML_HPP_
26
27
29#include "SpectrumListBase.hpp"
30#include <iosfwd>
31#include <stdexcept>
32
33
34namespace pwiz {
35namespace msdata {
36
37
38/// implementation of SpectrumList, backed by an mzXML file
40{
41 public:
42
43 static SpectrumListPtr create(boost::shared_ptr<std::istream> is,
44 const MSData& msd,
45 bool indexed = true);
46
47 /// exception thrown if create(*,*,true) is called and
48 /// the mzXML index cannot be found
49 struct index_not_found : public std::runtime_error
50 {
51 index_not_found(const std::string& what) : std::runtime_error(what.c_str()) {}
52 };
53};
54
55
56} // namespace msdata
57} // namespace pwiz
58
59
60#endif // _SPECTRUMLIST_MZXML_HPP_
61
#define PWIZ_API_DECL
Definition Export.hpp:32
implementation of SpectrumList, backed by an mzXML file
static SpectrumListPtr create(boost::shared_ptr< std::istream > is, const MSData &msd, bool indexed=true)
common functionality for base SpectrumList implementations
boost::shared_ptr< SpectrumList > SpectrumListPtr
Definition MSData.hpp:711
STL namespace.
This is the root element of ProteoWizard; it represents the mzML element, defined as: intended to cap...
Definition MSData.hpp:850
exception thrown if create(*,*,true) is called and the mzXML index cannot be found