ProteoWizard
Public Member Functions | Private Attributes
pwiz::proteome::Modification Class Reference

represents a post-translational modification (PTM) modification formula or masses must be provided at instantiation More...

#include <Modification.hpp>

List of all members.

Public Member Functions

 Modification ()
 constructs a zero-mass modification (provided for MSVC compatibility)
 Modification (const chemistry::Formula &formula)
 Modification (double monoisotopicDeltaMass, double averageDeltaMass)
 Modification (const Modification &)
Modificationoperator= (const Modification &)
 ~Modification ()
bool hasFormula () const
 returns true iff the mod was constructed with formula
const chemistry::Formulaformula () const
 returns the difference formula; throws runtime_error if hasFormula() = false
double monoisotopicDeltaMass () const
double averageDeltaMass () const
bool operator== (const Modification &rhs) const
 returns true iff delta masses are equal
bool operator< (const Modification &rhs) const
 returns true iff this mod has smaller delta masses

Private Attributes

boost::shared_ptr< Impl > impl_

Detailed Description

represents a post-translational modification (PTM) modification formula or masses must be provided at instantiation

Definition at line 41 of file Modification.hpp.


Constructor & Destructor Documentation

pwiz::proteome::Modification::Modification ( )

constructs a zero-mass modification (provided for MSVC compatibility)

pwiz::proteome::Modification::Modification ( const chemistry::Formula formula)
pwiz::proteome::Modification::Modification ( double  monoisotopicDeltaMass,
double  averageDeltaMass 
)
pwiz::proteome::Modification::Modification ( const Modification )
pwiz::proteome::Modification::~Modification ( )

Member Function Documentation

Modification& pwiz::proteome::Modification::operator= ( const Modification )
bool pwiz::proteome::Modification::hasFormula ( ) const

returns true iff the mod was constructed with formula

const chemistry::Formula& pwiz::proteome::Modification::formula ( ) const

returns the difference formula; throws runtime_error if hasFormula() = false

double pwiz::proteome::Modification::monoisotopicDeltaMass ( ) const

Referenced by fragmentTest(), and testConversion().

double pwiz::proteome::Modification::averageDeltaMass ( ) const
bool pwiz::proteome::Modification::operator== ( const Modification rhs) const

returns true iff delta masses are equal

bool pwiz::proteome::Modification::operator< ( const Modification rhs) const

returns true iff this mod has smaller delta masses


Member Data Documentation

boost::shared_ptr<Impl> pwiz::proteome::Modification::impl_
private

Definition at line 72 of file Modification.hpp.


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