Inheritance diagram for Reader2:

Classes
struct	Config
struct	ReaderConfig

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;
virtual void	read (const std::string &filename, const std::string &head, TraData &result, int runIndex=0) const
	fill in the TraData structure from the first (or only) sample
virtual void	read (const std::string &filename, const std::string &head, std::vector< TraDataPtr > &results) const
	fill in a vector of TraData structures; provides support for multi-run input files
const char *	getType () const
	fill in a vector of MSData.Id values; provides support for multi-run input files
virtual std::string	identify (const std::string &filename, const std::string &head) const
	return file type iff Reader recognizes the file, else empty;
virtual void	read (const std::string &filename, const std::string &head, MSData &result, int runIndex=0, const Config &config=Config()) const
virtual void	read (const std::string &filename, const std::string &head, std::vector< MSDataPtr > &results, const Config &config=Config()) const
const char *	getType () const
	fill in a vector of MSData.Id values; provides support for multi-run input files
virtual std::string	identify (const std::string &uri, boost::shared_ptr< std::istream > uriStreamPtr) const
virtual void	read (const std::string &uri, boost::shared_ptr< std::istream > uriStreamPtr, ProteomeData &result) const
const char *	getType () const
	fill in a vector of MSData.Id values; provides support for multi-run input files
virtual std::string	identify (const std::string &filename, const std::string &head) const
	return file type iff Reader recognizes the file, else empty;
virtual void	read (const std::string &filename, const std::string &head, TraData &result, int runIndex=0) const
	fill in the TraData structure from the first (or only) sample
virtual void	read (const std::string &filename, const std::string &head, std::vector< TraDataPtr > &results) const
	fill in a vector of TraData structures; provides support for multi-run input files
const char *	getType () const
	fill in a vector of MSData.Id values; provides support for multi-run input files
Public Member Functions inherited from pwiz::tradata::Reader
bool	accept (const std::string &filename, const std::string &head) const
	return true iff Reader recognizes the file as one it should handle
virtual	~Reader ()

Public Attributes
Config	config
ReaderConfig	readerConfig

Detailed Description

Definition at line 77 of file ReaderTest.cpp.

Member Function Documentation

virtual std::string Reader2::identify	(	const std::string &	filename,
		const std::string &	head
	)		const

inlinevirtual

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::tradata::Reader.

Definition at line 89 of file ReaderTest.cpp.

References os_.

    {
        bool result = (filename == "2"); 
        if (os_) *os_ << "Reader2::identify(): " << boolalpha << result << endl;
        return result ? filename : std::string("");
    }

virtual void Reader2::read	(	const std::string &	filename,
		const std::string &	head,
		TraData &	result,
		int	runIndex = `0`
	)		const

inlinevirtual

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

Implements pwiz::tradata::Reader.

Definition at line 96 of file ReaderTest.cpp.

References os_.

    {
        if (os_) *os_ << "Reader2::read()\n";
        config.done = true;
    }

virtual void Reader2::read	(	const std::string &	filename,
		const std::string &	head,
		std::vector< TraDataPtr > &	results
	)		const

inlinevirtual

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

Implements pwiz::tradata::Reader.

Definition at line 105 of file ReaderTest.cpp.

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

    {
        results.push_back(TraDataPtr(new TraData));
        read(filename, head, *results.back());
    }

const char* Reader2::getType ( ) const

inlinevirtual

fill in a vector of MSData.Id values; provides support for multi-run input files

Implements pwiz::tradata::Reader.

Definition at line 113 of file ReaderTest.cpp.

{return "Reader2";} // satisfy inheritance

virtual std::string Reader2::identify	(	const std::string &	filename,
		const std::string &	head
	)		const

inlinevirtual

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::tradata::Reader.

Definition at line 98 of file ReaderTest.cpp.

References os_.

    {
        bool result = (filename == "2"); 
        if (os_) *os_ << "Reader2::identify(): " << boolalpha << result << endl;
        return std::string (result?filename:std::string("")); 
    }

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

inlinevirtual

Definition at line 105 of file ReaderTest.cpp.

References os_.

    {
        if (os_) *os_ << "Reader2::read()\n";
        readerConfig.done = true;
    }

virtual void Reader2::read	(	const std::string &	filename,
		const std::string &	head,
		std::vector< MSDataPtr > &	results,
		const Config &	config = `Config()`
	)		const

inlinevirtual

Definition at line 115 of file ReaderTest.cpp.

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

    {
        results.push_back(MSDataPtr(new MSData));
        read(filename, head, *results.back(), 0, config);
    }

const char* Reader2::getType ( ) const

inlinevirtual

fill in a vector of MSData.Id values; provides support for multi-run input files

Implements pwiz::tradata::Reader.

Definition at line 124 of file ReaderTest.cpp.

{return "Reader2";} // satisfy inheritance

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

inlinevirtual

Definition at line 80 of file ReaderTest.cpp.

References os_.

    {
        bool result = (uri == "2"); 
        if (os_) *os_ << "Reader2::identify(): " << boolalpha << result << endl;
        return std::string (result?uri:std::string("")); 
    }

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

inlinevirtual

Definition at line 87 of file ReaderTest.cpp.

References os_.

    {
        if (os_) *os_ << "Reader2::read()\n";
        config.done = true;
    }

const char* Reader2::getType ( ) const

inlinevirtual

fill in a vector of MSData.Id values; provides support for multi-run input files

Implements pwiz::tradata::Reader.

Definition at line 95 of file ReaderTest.cpp.

{return "Reader2";} // satisfy inheritance

virtual std::string Reader2::identify	(	const std::string &	filename,
		const std::string &	head
	)		const

inlinevirtual

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::tradata::Reader.

Definition at line 89 of file ReaderTest.cpp.

References os_.

    {
        bool result = (filename == "2"); 
        if (os_) *os_ << "Reader2::identify(): " << boolalpha << result << endl;
        return result ? filename : std::string("");
    }

virtual void Reader2::read	(	const std::string &	filename,
		const std::string &	head,
		TraData &	result,
		int	runIndex = `0`
	)		const

inlinevirtual

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

Implements pwiz::tradata::Reader.

Definition at line 96 of file ReaderTest.cpp.

References os_.

    {
        if (os_) *os_ << "Reader2::read()\n";
        config.done = true;
    }

virtual void Reader2::read	(	const std::string &	filename,
		const std::string &	head,
		std::vector< TraDataPtr > &	results
	)		const

inlinevirtual

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

Implements pwiz::tradata::Reader.

Definition at line 105 of file ReaderTest.cpp.

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

    {
        results.push_back(TraDataPtr(new TraData));
        read(filename, head, *results.back());
    }

const char* Reader2::getType ( ) const

inlinevirtual

fill in a vector of MSData.Id values; provides support for multi-run input files

Implements pwiz::tradata::Reader.

Definition at line 113 of file ReaderTest.cpp.

{return "Reader2";} // satisfy inheritance

Member Data Documentation

Config Reader2::config

Definition at line 87 of file ReaderTest.cpp.

Referenced by testGet(), and testRead().

ReaderConfig Reader2::readerConfig

Definition at line 96 of file ReaderTest.cpp.

Referenced by testGet(), and testRead().

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

/Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/identdata/ReaderTest.cpp
/Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/ReaderTest.cpp
/Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/proteome/ReaderTest.cpp
/Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/tradata/ReaderTest.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation