ProteoWizard
MascotReader.hpp
Go to the documentation of this file.
1 //
2 // $Id$
3 //
4 //
5 // Origional author: Robert Burke <robert.burke@proteowizard.org>
6 //
7 // Copyright 2010 Spielberg Family Center for Applied Proteomics
8 // University of Southern California, Los Angeles, California 90033
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 _MZID_MASCOTREADER_HPP_
25 #define _MZID_MASCOTREADER_HPP_
26 
29 
30 namespace pwiz {
31 namespace identdata {
32 
34 {
35 public:
38 
39  virtual std::string identify(const std::string& filename,
40  const std::string& head) const;
41 
42  virtual void read(const std::string& filename,
43  const std::string& head,
44  IdentData& result,
45  const Reader::Config&) const;
46 
47  virtual void read(const std::string& filename,
48  const std::string& head,
49  IdentDataPtr& result,
50  const Reader::Config&) const;
51 
52  virtual void read(const std::string& filename,
53  const std::string& head,
54  std::vector<IdentDataPtr>& results,
55  const Reader::Config&) const;
56 
57  virtual const char *getType() const { return "Mascot DAT"; }
58 
59 private:
60  class Impl;
61 
62  Impl* pimpl;
63 };
64 
65 } // namespace pwiz
66 } // namespace identdata
67 
68 #endif // _MZID_MASCOTREADER_HPP_
pwiz::identdata::MascotReader::read
virtual void read(const std::string &filename, const std::string &head, IdentDataPtr &result, const Reader::Config &) const
fill in a vector of IdentData structures; provides support for multi-run input files
pwiz::identdata::MascotReader::read
virtual void read(const std::string &filename, const std::string &head, std::vector< IdentDataPtr > &results, const Reader::Config &) const
fill in a vector of IdentData structures; provides support for multi-run input files
pwiz
Definition: ChromatogramList_Filter.hpp:36
pwiz::identdata::Reader::Config
HACK: provide an option to read only file-level metadata; once we have an enumerable ResultList imple...
Definition: Reader.hpp:47
pwiz::identdata::MascotReader::~MascotReader
~MascotReader()
Definition: MascotReader.hpp:37
pwiz::identdata::MascotReader::identify
virtual std::string identify(const std::string &filename, const std::string &head) const
return file type iff Reader recognizes the file, else empty;
PWIZ_API_DECL
#define PWIZ_API_DECL
Definition: Export.hpp:32
pwiz::identdata::Reader
interface for file readers
Definition: Reader.hpp:39
pwiz::identdata::MascotReader::read
virtual void read(const std::string &filename, const std::string &head, IdentData &result, const Reader::Config &) const
fill in a vector of IdentData structures; provides support for multi-run input files
Export.hpp
pwiz::identdata::IdentDataPtr
boost::shared_ptr< IdentData > IdentDataPtr
Definition: Pep2MzIdent.hpp:38
pwiz::identdata::MascotReader::getType
virtual const char * getType() const
Definition: MascotReader.hpp:57
pwiz::identdata::IdentData
Implementation of the MzIdentMLType from the mzIdentML schema.
Definition: IdentData.hpp:994
pwiz::identdata::MascotReader
Definition: MascotReader.hpp:34
Reader.hpp
pwiz::identdata::MascotReader::MascotReader
MascotReader()
pwiz::identdata::MascotReader::pimpl
Impl * pimpl
Definition: MascotReader.hpp:60