Reader container (composite pattern). More...

#include <Reader.hpp>

Inheritance diagram for pwiz::tradata::ReaderList:

Public Member Functions
virtual std::string	identify (const std::string &filename) const
	returns child name iff some child identifies, else empty string
virtual std::string	identify (const std::string &filename, const std::string &head) const
	returns child name iff some child identifies, else empty string
virtual void	read (const std::string &filename, TraData &result, int runIndex=0) const
	delegates to first child that identifies
virtual void	read (const std::string &filename, const std::string &head, TraData &result, int runIndex=0) const
	delegates to first child that identifies
virtual void	read (const std::string &filename, std::vector< TraDataPtr > &results) const
	delegates to first child that identifies; provides support for multi-run input files
virtual void	read (const std::string &filename, const std::string &head, std::vector< TraDataPtr > &results) const
	delegates to first child that identifies; provides support for multi-run input files
ReaderList &	operator+= (const ReaderList &rhs)
	delegates to first child that identifies; provides support for multi-run input files
ReaderList &	operator+= (const ReaderPtr &rhs)
	appends the rhs Reader to the list
ReaderList	operator+ (const ReaderList &rhs) const
	returns a concatenated list of all the Readers from the lhs and rhs operands
ReaderList	operator+ (const ReaderPtr &rhs) const
	returns a concatenated list of all the Readers from the lhs and rhs operands
template<typename reader_type >
reader_type *	get ()
	returns pointer to Reader of the specified type
template<typename reader_type >
const reader_type *	get () const
	returns const pointer to Reader of the specified type
virtual const char *	getType () const
Public Member Functions inherited from pwiz::proteome::Reader
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	~Reader ()

Additional Inherited Members
Public Attributes inherited from std::vector< T >
T	elements
	STL member.

Detailed Description

Reader container (composite pattern).

The template get<reader_type>() gives access to child Readers by type, to facilitate Reader-specific configuration at runtime.

Definition at line 104 of file Reader.hpp.

Member Function Documentation

virtual std::string pwiz::tradata::ReaderList::identify ( const std::string & filename ) const

virtual

returns child name iff some child identifies, else empty string

virtual std::string pwiz::tradata::ReaderList::identify	(	const std::string &	filename,
		const std::string &	head
	)		const

virtual

returns child name iff some child identifies, else empty string

virtual void pwiz::tradata::ReaderList::read	(	const std::string &	filename,
		TraData &	result,
		int	runIndex = `0`
	)		const

virtual

delegates to first child that identifies

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

virtual

delegates to first child that identifies

virtual void pwiz::tradata::ReaderList::read	(	const std::string &	filename,
		std::vector< TraDataPtr > &	results
	)		const

virtual

delegates to first child that identifies; provides support for multi-run input files

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

virtual

delegates to first child that identifies; provides support for multi-run input files

ReaderList& pwiz::tradata::ReaderList::operator+= ( const ReaderList & rhs )

delegates to first child that identifies; provides support for multi-run input files

delegates to first child that identifies; provides support for multi-run input files appends all of the rhs operand's Readers to the list

ReaderList& pwiz::tradata::ReaderList::operator+= ( const ReaderPtr & rhs )

appends the rhs Reader to the list

ReaderList pwiz::tradata::ReaderList::operator+ ( const ReaderList & rhs ) const

returns a concatenated list of all the Readers from the lhs and rhs operands

ReaderList pwiz::tradata::ReaderList::operator+ ( const ReaderPtr & rhs ) const

returns a concatenated list of all the Readers from the lhs and rhs operands

template<typename reader_type >

reader_type* pwiz::tradata::ReaderList::get ( )

inline

returns pointer to Reader of the specified type

Definition at line 163 of file Reader.hpp.

    {
        for (iterator it=begin(); it!=end(); ++it)
        {
            reader_type* p = dynamic_cast<reader_type*>(it->get());
            if (p) return p;
        }
        return 0;
    }

template<typename reader_type >

const reader_type* pwiz::tradata::ReaderList::get ( ) const

inline

returns const pointer to Reader of the specified type

Definition at line 176 of file Reader.hpp.

    {
        return const_cast<ReaderList*>(this)->get<reader_type>();
    }

virtual const char* pwiz::tradata::ReaderList::getType ( ) const

inlinevirtual

Implements pwiz::proteome::Reader.

Definition at line 181 of file Reader.hpp.

{return "ReaderList";} // satisfy inheritance

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

/Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/tradata/Reader.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation