ProteoWizard
Public Member Functions | List of all members
pwiz::tradata::ReaderList Class Reference

Reader container (composite pattern). More...

#include <Reader.hpp>

Inheritance diagram for pwiz::tradata::ReaderList:
pwiz::proteome::Reader

Public Member Functions

virtual std::string identify (const std::string &filename) const
 returns child name iff some child identifies, else empty string More...
 
virtual std::string identify (const std::string &filename, const std::string &head) const
 returns child name iff some child identifies, else empty string More...
 
virtual void read (const std::string &filename, TraData &result, int runIndex=0) const
 delegates to first child that identifies More...
 
virtual void read (const std::string &filename, const std::string &head, TraData &result, int runIndex=0) const
 delegates to first child that identifies More...
 
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 More...
 
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 More...
 
ReaderListoperator+= (const ReaderList &rhs)
 delegates to first child that identifies; provides support for multi-run input files More...
 
ReaderListoperator+= (const ReaderPtr &rhs)
 appends the rhs Reader to the list More...
 
ReaderList operator+ (const ReaderList &rhs) const
 returns a concatenated list of all the Readers from the lhs and rhs operands More...
 
ReaderList operator+ (const ReaderPtr &rhs) const
 returns a concatenated list of all the Readers from the lhs and rhs operands More...
 
template<typename reader_type >
reader_type * get ()
 returns pointer to Reader of the specified type More...
 
template<typename reader_type >
const reader_type * get () const
 returns const pointer to Reader of the specified type More...
 
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 More...
 
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; More...
 
virtual void read (const std::string &uri, ProteomeData &result) const
 fill in the ProteomeData structure from a new URI stream More...
 
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 More...
 
virtual ~Reader ()
 

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

§ identify() [1/2]

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

returns child name iff some child identifies, else empty string

§ identify() [2/2]

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

§ read() [1/4]

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

delegates to first child that identifies

§ read() [2/4]

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

§ read() [3/4]

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

§ read() [4/4]

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

§ operator+=() [1/2]

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

§ operator+=() [2/2]

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

appends the rhs Reader to the list

§ operator+() [1/2]

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

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

§ operator+() [2/2]

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

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

§ get() [1/2]

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.

164  {
165  for (iterator it=begin(); it!=end(); ++it)
166  {
167  reader_type* p = dynamic_cast<reader_type*>(it->get());
168  if (p) return p;
169  }
170 
171  return 0;
172  }

§ get() [2/2]

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.

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

§ getType()

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

Implements pwiz::proteome::Reader.

Definition at line 181 of file Reader.hpp.

References pwiz::tradata::operator+(), and PWIZ_API_DECL.

181 {return "ReaderList";} // satisfy inheritance

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