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

#include <DelimReader.hpp>

Inheritance diagram for pwiz::identdata::DelimReader:
pwiz::identdata::Reader

Public Types

enum  Param { mzType, ScoreType }
 

Public Member Functions

 DelimReader ()
 
virtual ~DelimReader ()
 
DelimReaderset (Param param, const std::string &value)
 
const std::string get (Param param) const
 
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
 
virtual void read (const std::string &filename, const std::string &head, IdentDataPtr &result) const
 
virtual void read (const std::string &filename, const std::string &head, std::vector< IdentDataPtr > &results) const
 
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, const std::string &head, IdentData &results, const Config &config=Config()) const =0
 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 void read (const std::string &filename, const std::string &head, IdentDataPtr &results, const Config &config=Config()) const =0
 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 Config &config=Config()) const =0
 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 36 of file DelimReader.hpp.

Member Enumeration Documentation

§ Param

Enumerator
mzType 
ScoreType 

Definition at line 42 of file DelimReader.hpp.

Constructor & Destructor Documentation

§ DelimReader()

pwiz::identdata::DelimReader::DelimReader ( )

§ ~DelimReader()

virtual pwiz::identdata::DelimReader::~DelimReader ( )
virtual

Member Function Documentation

§ set()

DelimReader& pwiz::identdata::DelimReader::set ( Param  param,
const std::string &  value 
)

§ get()

const std::string pwiz::identdata::DelimReader::get ( Param  param) const

§ identify()

virtual std::string pwiz::identdata::DelimReader::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::DelimReader::read ( const std::string &  filename,
const std::string &  head,
IdentData result 
) const
virtual

§ read() [2/3]

virtual void pwiz::identdata::DelimReader::read ( const std::string &  filename,
const std::string &  head,
IdentDataPtr result 
) const
virtual

§ read() [3/3]

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

§ getType()

virtual const char* pwiz::identdata::DelimReader::getType ( ) const
virtual

Member Data Documentation

§ pimpl

Impl* pwiz::identdata::DelimReader::pimpl
private

Definition at line 69 of file DelimReader.hpp.


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