ProteoWizard
Public Member Functions | Private Attributes | List of all members
pwiz::identdata::MascotReader Class Reference

#include <MascotReader.hpp>

Inheritance diagram for pwiz::identdata::MascotReader:
pwiz::identdata::Reader

Public Member Functions

 MascotReader ()
 
 ~MascotReader ()
 
virtual std::string identify (const std::string &filename, const std::string &head) const
 return file type iff Reader recognizes the file, else empty; More...
 
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 More...
 
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 More...
 
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 More...
 
virtual const char * getType () const
 
- Public Member Functions inherited from pwiz::identdata::Reader
bool accept (const std::string &filename, const std::string &head) const
 return true iff Reader recognizes the file as one it should handle More...
 
virtual void read (const std::string &filename, IdentData &results, const Config &config=Config()) const
 fill in a vector of IdentData structures; provides support for multi-run input files More...
 
virtual void read (const std::string &filename, IdentDataPtr &results, const Config &config=Config()) const
 fill in a vector of IdentData structures; provides support for multi-run input files More...
 
virtual ~Reader ()
 

Private Attributes

Impl * pimpl
 

Detailed Description

Definition at line 33 of file MascotReader.hpp.

Constructor & Destructor Documentation

§ MascotReader()

pwiz::identdata::MascotReader::MascotReader ( )

§ ~MascotReader()

pwiz::identdata::MascotReader::~MascotReader ( )
inline

Definition at line 37 of file MascotReader.hpp.

References pwiz::identdata::IO::read().

37 {}

Member Function Documentation

§ identify()

virtual std::string pwiz::identdata::MascotReader::identify ( const std::string &  filename,
const std::string &  head 
) const
virtual

return file type iff Reader recognizes the file, else empty;

note: for formats requiring a 3rd party DLL identify() should return true if it recognized the format, even though reading may fail if the 3rd party DLL isn't actually present Reader may filter based on filename and/or head of the file

Implements pwiz::identdata::Reader.

§ read() [1/3]

virtual void pwiz::identdata::MascotReader::read ( const std::string &  filename,
const std::string &  head,
IdentData results,
const Reader::Config config 
) const
virtual

fill in a vector of IdentData structures; provides support for multi-run input files

Implements pwiz::identdata::Reader.

§ read() [2/3]

virtual void pwiz::identdata::MascotReader::read ( const std::string &  filename,
const std::string &  head,
IdentDataPtr results,
const Reader::Config config 
) const
virtual

fill in a vector of IdentData structures; provides support for multi-run input files

Implements pwiz::identdata::Reader.

§ read() [3/3]

virtual void pwiz::identdata::MascotReader::read ( const std::string &  filename,
const std::string &  head,
std::vector< IdentDataPtr > &  results,
const Reader::Config config 
) const
virtual

fill in a vector of IdentData structures; provides support for multi-run input files

Implements pwiz::identdata::Reader.

§ getType()

virtual const char* pwiz::identdata::MascotReader::getType ( ) const
inlinevirtual

Implements pwiz::identdata::Reader.

Definition at line 57 of file MascotReader.hpp.

57 { return "Mascot DAT"; }

Member Data Documentation

§ pimpl

Impl* pwiz::identdata::MascotReader::pimpl
private

Definition at line 60 of file MascotReader.hpp.


The documentation for this class was generated from the following file: