pwiz::proteome::Reader Class Reference

interface for file readers More...

#include <Reader.hpp>

Inheritance diagram for pwiz::proteome::Reader:

List of all members.

Public Member Functions
bool	accept (const std::string &uri, boost::shared_ptr< std::istream > uriStreamPtr) const
	return true iff Reader recognizes the file as one it should handle
virtual std::string	identify (const std::string &uri, boost::shared_ptr< std::istream > uriStreamPtr) const =0
	return file type iff Reader recognizes the file, else empty;
virtual void	read (const std::string &uri, ProteomeData &result) const
	fill in the ProteomeData structure from a new URI stream
virtual void	read (const std::string &uri, boost::shared_ptr< std::istream > uriStreamPtr, ProteomeData &result) const =0
	fill in the ProteomeData structure from a shared URI stream
virtual const char *	getType () const =0
virtual	~Reader ()

---

Detailed Description

interface for file readers

Definition at line 36 of file Reader.hpp.

---

Constructor & Destructor Documentation

virtual pwiz::proteome::Reader::~Reader ( )

inlinevirtual

Definition at line 70 of file Reader.hpp.

{}

---

Member Function Documentation

bool pwiz::proteome::Reader::accept ( const std::string &  uri, boost::shared_ptr< std::istream >  uriStreamPtr  ) 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 44 of file Reader.hpp.

Referenced by testAccept(), and testRead().

        {
                return (identify(uri, uriStreamPtr).length() != 0);
        }

virtual std::string pwiz::proteome::Reader::identify ( const std::string &  uri, boost::shared_ptr< std::istream >  uriStreamPtr  ) const

pure 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 URI and/or contents of the file

Implemented in pwiz::proteome::ReaderList, and pwiz::proteome::Reader_FASTA.

virtual void pwiz::proteome::Reader::read ( const std::string &  uri, ProteomeData &  result  ) const

virtual

fill in the ProteomeData structure from a new URI stream

Reimplemented in pwiz::proteome::ReaderList.

virtual void pwiz::proteome::Reader::read ( const std::string &  uri, boost::shared_ptr< std::istream >  uriStreamPtr, ProteomeData &  result  ) const

pure virtual

fill in the ProteomeData structure from a shared URI stream

Implemented in pwiz::proteome::ReaderList, and pwiz::proteome::Reader_FASTA.

virtual const char* pwiz::proteome::Reader::getType ( ) const

pure virtual

Implemented in TestReader, pwiz::tradata::ReaderList, TestReader, pwiz::proteome::ReaderList, and pwiz::proteome::Reader_FASTA.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/proteome/Reader.hpp