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

This class allows access to identified proteins in PeptideProphet files. More...

#include <PeptideID_pepXML.hpp>

Inheritance diagram for pwiz::peptideid::PeptideID_pepXml:
pwiz::peptideid::PeptideID

Public Member Functions

 PeptideID_pepXml (const std::string &filename)
 Constructor taking path to input file in std::string. More...
 
 PeptideID_pepXml (const char *filename)
 Constructor taking path to input file from const char*. More...
 
 PeptideID_pepXml (std::istream *in)
 Constructor taking std::istream as input. More...
 
virtual ~PeptideID_pepXml ()
 Destructor. More...
 
virtual Record record (const Location &location) const
 Returns the Record object associated with the given nativeID. More...
 
virtual std::multimap< double, boost::shared_ptr< PeptideID::Record > >::const_iterator record (double retention_time_sec) const
 
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 identified proteins in PeptideProphet files.

A PeptideID_pepXML object is contructed with either the path to a PeptideProphet format file (*.pep.xml), or an std::istream open to the beginning of a pep.xml file.

Definition at line 41 of file PeptideID_pepXML.hpp.

Constructor & Destructor Documentation

§ PeptideID_pepXml() [1/3]

pwiz::peptideid::PeptideID_pepXml::PeptideID_pepXml ( const std::string &  filename)

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

§ PeptideID_pepXml() [2/3]

pwiz::peptideid::PeptideID_pepXml::PeptideID_pepXml ( const char *  filename)

Constructor taking path to input file from const char*.

§ PeptideID_pepXml() [3/3]

pwiz::peptideid::PeptideID_pepXml::PeptideID_pepXml ( std::istream *  in)

Constructor taking std::istream as input.

§ ~PeptideID_pepXml()

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

Destructor.

Definition at line 54 of file PeptideID_pepXML.hpp.

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

54 {}

Member Function Documentation

§ record() [1/2]

virtual Record pwiz::peptideid::PeptideID_pepXml::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 testFilename(), and testIStream().

§ record() [2/2]

virtual std::multimap<double, boost::shared_ptr<PeptideID::Record> >::const_iterator pwiz::peptideid::PeptideID_pepXml::record ( double  retention_time_sec) const
virtual

§ begin()

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

§ end()

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

Member Data Documentation

§ pimpl

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

Definition at line 69 of file PeptideID_pepXML.hpp.


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