ProteoWizard
Public Member Functions | Private Attributes
pwiz::identdata::Pep2MzIdent Class Reference

Translates data from a MinimumPepXML object into a IdentData object tree when a translation is known. More...

#include <Pep2MzIdent.hpp>

List of all members.

Public Member Functions

 Pep2MzIdent (const MSMSPipelineAnalysis &mspa, IdentDataPtr result=IdentDataPtr(new IdentData()))
 Initialized the member variables.
void clear ()
 Resets the member variables.
bool operator() (const MSMSPipelineAnalysis &pepxml, IdentDataPtr mzid)
IdentDataPtr translate ()
 Translates all known tags in the pepXML object tree into the IdentData object tree.
void setMspa (const MSMSPipelineAnalysis &mspa)
 Clears fields and then sets the _mspa field to the address of mspa.
IdentDataPtr getIdentData () const
 Returns the IdentDataPtr object.
void setDebug (bool debug)
bool getDebug () const
void setVerbose (bool verbose)
bool getVerbose () const
void addParamMap (std::vector< CVMapPtr > &map)
void setParamMap (std::vector< CVMapPtr > &map)
const std::vector< CVMapPtr > & getParamMap () const

Private Attributes

boost::shared_ptr< Impl > pimpl

Detailed Description

Translates data from a MinimumPepXML object into a IdentData object tree when a translation is known.

The IdentData object initializes a cvList with the "MS" and "UO" elements.

The translate method is used to copy data. The clear method resets the IdentData object, null's out the MSMSPipelineAnalysis.

Definition at line 46 of file Pep2MzIdent.hpp.


Constructor & Destructor Documentation

pwiz::identdata::Pep2MzIdent::Pep2MzIdent ( const MSMSPipelineAnalysis mspa,
IdentDataPtr  result = IdentDataPtr(new IdentData()) 
)

Initialized the member variables.

Also adds the "MS" and "UO" CV's to the cvList.


Member Function Documentation

void pwiz::identdata::Pep2MzIdent::clear ( )

Resets the member variables.

bool pwiz::identdata::Pep2MzIdent::operator() ( const MSMSPipelineAnalysis pepxml,
IdentDataPtr  mzid 
)
IdentDataPtr pwiz::identdata::Pep2MzIdent::translate ( )

Translates all known tags in the pepXML object tree into the IdentData object tree.

The resulting IdentDataPtr is returned.

Referenced by test().

void pwiz::identdata::Pep2MzIdent::setMspa ( const MSMSPipelineAnalysis mspa)

Clears fields and then sets the _mspa field to the address of mspa.

IdentDataPtr pwiz::identdata::Pep2MzIdent::getIdentData ( ) const

Returns the IdentDataPtr object.

If a translation has not been done, or if clear has been called, then an empty IdentData will be return in the IdentDataPtr object.

void pwiz::identdata::Pep2MzIdent::setDebug ( bool  debug)
bool pwiz::identdata::Pep2MzIdent::getDebug ( ) const
void pwiz::identdata::Pep2MzIdent::setVerbose ( bool  verbose)
bool pwiz::identdata::Pep2MzIdent::getVerbose ( ) const
void pwiz::identdata::Pep2MzIdent::addParamMap ( std::vector< CVMapPtr > &  map)
void pwiz::identdata::Pep2MzIdent::setParamMap ( std::vector< CVMapPtr > &  map)
const std::vector<CVMapPtr>& pwiz::identdata::Pep2MzIdent::getParamMap ( ) const

Member Data Documentation

boost::shared_ptr<Impl> pwiz::identdata::Pep2MzIdent::pimpl
private

Definition at line 88 of file Pep2MzIdent.hpp.


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