ProteoWizard
Public Member Functions | Private Attributes | List of all members
pwiz::proteome::Modification Class Reference

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

#include <Modification.hpp>

Public Member Functions

 Modification ()
 constructs a zero-mass modification (provided for MSVC compatibility) More...
 
 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 More...
 
const chemistry::Formulaformula () const
 returns the difference formula; throws runtime_error if hasFormula() = false More...
 
double monoisotopicDeltaMass () const
 
double averageDeltaMass () const
 
bool operator== (const Modification &rhs) const
 returns true iff delta masses are equal More...
 
bool operator< (const Modification &rhs) const
 returns true iff this mod has smaller delta masses More...
 

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

§ Modification() [1/4]

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

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

§ Modification() [2/4]

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

§ Modification() [3/4]

pwiz::proteome::Modification::Modification ( double  monoisotopicDeltaMass,
double  averageDeltaMass 
)

§ Modification() [4/4]

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

§ ~Modification()

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

Member Function Documentation

§ operator=()

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

§ hasFormula()

bool pwiz::proteome::Modification::hasFormula ( ) const

returns true iff the mod was constructed with formula

§ formula()

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

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

§ monoisotopicDeltaMass()

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

Referenced by fragmentTest(), and testConversion().

§ averageDeltaMass()

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

§ operator==()

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

returns true iff delta masses are equal

§ operator<()

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

returns true iff this mod has smaller delta masses

Member Data Documentation

§ impl_

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: