interface for file readers More...

#include <Reader.hpp>

Inheritance diagram for pwiz::identdata::Reader:

Classes
struct	Config
	HACK: provide an option to read only file-level metadata; once we have an enumerable ResultList implementation this will be deprecated. More...

Public Member Functions
bool	accept (const std::string &filename, const std::string &head) const
	return true iff Reader recognizes the file as one it should handle
virtual std::string	identify (const std::string &filename, const std::string &head) const =0
	return file type iff Reader recognizes the file, else empty;
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
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
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
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
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
virtual const char *	getType () const =0
virtual	~Reader ()

Detailed Description

interface for file readers

Definition at line 38 of file Reader.hpp.

Constructor & Destructor Documentation

virtual pwiz::identdata::Reader::~Reader ( )

inlinevirtual

Definition at line 105 of file Reader.hpp.

{}

Member Function Documentation

bool pwiz::identdata::Reader::accept	(	const std::string &	filename,
		const std::string &	head
	)		const

inline

return true iff Reader recognizes the file as one it should handle

that's not to say one it CAN handle, necessarily, as in Thermo on linux, see comment for identify() below

Definition at line 61 of file Reader.hpp.

        {
                return (identify(filename,head).length() != 0);
        }

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

pure 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

Implemented in pwiz::identdata::ReaderList, pwiz::identdata::DelimReader, and pwiz::identdata::MascotReader.

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

virtual