ProteoWizard
Public Member Functions | Private Attributes | List of all members
pwiz::peptideid::PeptideID_flat Class Reference

This class allows access to peptides listed in a flat tab delimited text file. More...

#include <PeptideID_flat.hpp>

Inheritance diagram for pwiz::peptideid::PeptideID_flat:
pwiz::peptideid::PeptideID

Public Member Functions

 PeptideID_flat (const std::string &filename, boost::shared_ptr< FlatRecordBuilder > builder=boost::shared_ptr< FlatRecordBuilder >(new FlatRecordBuilder()))
 Constructor taking path to input file in std::string. More...
 
 PeptideID_flat (std::istream *in, boost::shared_ptr< FlatRecordBuilder > builder=boost::shared_ptr< FlatRecordBuilder >(new FlatRecordBuilder()))
 Constructor taking std::istream as input. More...
 
virtual ~PeptideID_flat ()
 Destructor. More...
 
virtual Record record (const Location &location) const
 Returns the Record object associated with the given nativeID. More...
 
virtual Iterator begin () const
 
virtual Iterator end () const
 
- Public Member Functions inherited from pwiz::peptideid::PeptideID
virtual ~PeptideID ()
 

Private Attributes

boost::shared_ptr< Impl > pimpl
 

Detailed Description

This class allows access to peptides listed in a flat tab delimited text file.

A PeptideID_flat object is contructed with either the path to a tab delimited file (*.txt/*.tab), or an std::istream open to the beginning of a tab delimited file.

Definition at line 77 of file PeptideID_flat.hpp.

Constructor & Destructor Documentation

§ PeptideID_flat() [1/2]

pwiz::peptideid::PeptideID_flat::PeptideID_flat ( const std::string &  filename,
boost::shared_ptr< FlatRecordBuilder builder = boost::shared_ptr< FlatRecordBuilder >(new FlatRecordBuilder()) 
)

Constructor taking path to input file in std::string.

§ PeptideID_flat() [2/2]

pwiz::peptideid::PeptideID_flat::PeptideID_flat ( std::istream *  in,
boost::shared_ptr< FlatRecordBuilder builder = boost::shared_ptr< FlatRecordBuilder >(new FlatRecordBuilder()) 
)

Constructor taking std::istream as input.

§ ~PeptideID_flat()

virtual pwiz::peptideid::PeptideID_flat::~PeptideID_flat ( )
inlinevirtual

Destructor.

Definition at line 91 of file PeptideID_flat.hpp.

References pwiz::proteome::AminoAcid::Info::record().

91 {}

Member Function Documentation

§ record()

virtual Record pwiz::peptideid::PeptideID_flat::record ( const Location location) const
virtual

Returns the Record object associated with the given nativeID.

A range_error is thrown if the nativeID isn't associated with a Record.

Implements pwiz::peptideid::PeptideID.

Referenced by testIStream(), and testMSInspectIStream().

§ begin()

virtual Iterator pwiz::peptideid::PeptideID_flat::begin ( ) const
virtual

§ end()

virtual Iterator pwiz::peptideid::PeptideID_flat::end ( ) const
virtual

Member Data Documentation

§ pimpl

boost::shared_ptr<Impl> pwiz::peptideid::PeptideID_flat::pimpl
private

Definition at line 103 of file PeptideID_flat.hpp.


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