ProteoWizard
Public Member Functions | List of all members
pwiz::msdata::Reader_UIMF Class Reference

#include <Reader_UIMF.hpp>

Inheritance diagram for pwiz::msdata::Reader_UIMF:
pwiz::msdata::Reader

Public Member Functions

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, MSData &result, int runIndex=0, const Config &config=Config()) const
 fill in the MSData structure from the first (or only) sample More...
 
virtual void read (const std::string &filename, const std::string &head, std::vector< MSDataPtr > &results, const Config &config=Config()) const
 fill in a vector of MSData structures; provides support for multi-run input files More...
 
virtual const char * getType () const
 returns a unique string identifying the reader type More...
 
- Public Member Functions inherited from pwiz::msdata::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 readIds (const std::string &filename, const std::string &head, std::vector< std::string > &dataIds, const Config &config=Config()) const
 fill in a vector of MSData.Id values; provides support for multi-run input files More...
 
virtual ~Reader ()
 

Detailed Description

Definition at line 35 of file Reader_UIMF.hpp.

Member Function Documentation

§ identify()

virtual std::string pwiz::msdata::Reader_UIMF::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 non-empty 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::msdata::Reader.

§ read() [1/2]

virtual void pwiz::msdata::Reader_UIMF::read ( const std::string &  filename,
const std::string &  head,
MSData result,
int  runIndex = 0,
const Config config = Config() 
) const
virtual

fill in the MSData structure from the first (or only) sample

Implements pwiz::msdata::Reader.

§ read() [2/2]

virtual void pwiz::msdata::Reader_UIMF::read ( const std::string &  filename,
const std::string &  head,
std::vector< MSDataPtr > &  results,
const Config config = Config() 
) const
inlinevirtual

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

Implements pwiz::msdata::Reader.

Definition at line 48 of file Reader_UIMF.hpp.

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

52  {
53  results.push_back(MSDataPtr(new MSData));
54  read(filename, head, *results.back(), 0, config);
55  }
boost::shared_ptr< MSData > MSDataPtr
Definition: MSData.hpp:909
virtual void read(const std::string &filename, const std::string &head, MSData &result, int runIndex=0, const Config &config=Config()) const
fill in the MSData structure from the first (or only) sample

§ getType()

virtual const char* pwiz::msdata::Reader_UIMF::getType ( ) const
inlinevirtual

returns a unique string identifying the reader type

Implements pwiz::msdata::Reader.

Definition at line 57 of file Reader_UIMF.hpp.

57 {return "UIMF";}

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