OpenMS  2.7.0
Public Member Functions | Private Attributes | List of all members
OSWPeptidePrecursor Class Reference

A peptide with a charge state. More...

#include <OpenMS/DATASTRUCTURES/OSWData.h>

Collaboration diagram for OSWPeptidePrecursor:
[legend]

Public Member Functions

 OSWPeptidePrecursor ()=default
 just a dummy feature to allow for acceptor output values etc More...
 
 OSWPeptidePrecursor (const String &seq, const short charge, const bool decoy, const float precursor_mz, std::vector< OSWPeakGroup > &&features)
 custom c'tor which fills all the members with data; all members are read-only More...
 
 OSWPeptidePrecursor (const OSWPeptidePrecursor &rhs)=default
 Copy c'tor. More...
 
OSWPeptidePrecursoroperator= (const OSWPeptidePrecursor &rhs)=default
 assignment operator More...
 
 OSWPeptidePrecursor (OSWPeptidePrecursor &&rhs)=default
 move c'tor More...
 
OSWPeptidePrecursoroperator= (OSWPeptidePrecursor &&rhs)=default
 move assignment operator More...
 
const StringgetSequence () const
 the peptide sequence (incl. mods) More...
 
short getCharge () const
 precursor charge More...
 
bool isDecoy () const
 is this a decoy feature (from a decoy protein) More...
 
float getPCMz () const
 m/z of this charged peptide More...
 
const std::vector< OSWPeakGroup > & getFeatures () const
 candidate explanations More...
 

Private Attributes

String seq_
 
short charge_ {0}
 
bool decoy_ {false}
 
float precursor_mz_ {0}
 
std::vector< OSWPeakGroupfeatures_
 

Detailed Description

A peptide with a charge state.

An OSWProtein has one or more OSWPeptidePrecursors.

The OSWPeptidePrecursor contains multiple candidate features (peak groups) of type OSWPeakGroup, only one of which is usually true.

Constructor & Destructor Documentation

◆ OSWPeptidePrecursor() [1/4]

OSWPeptidePrecursor ( )
default

just a dummy feature to allow for acceptor output values etc

◆ OSWPeptidePrecursor() [2/4]

OSWPeptidePrecursor ( const String seq,
const short  charge,
const bool  decoy,
const float  precursor_mz,
std::vector< OSWPeakGroup > &&  features 
)

custom c'tor which fills all the members with data; all members are read-only

◆ OSWPeptidePrecursor() [3/4]

OSWPeptidePrecursor ( const OSWPeptidePrecursor rhs)
default

Copy c'tor.

◆ OSWPeptidePrecursor() [4/4]

move c'tor

Member Function Documentation

◆ getCharge()

short getCharge ( ) const
inline

precursor charge

◆ getFeatures()

const std::vector<OSWPeakGroup>& getFeatures ( ) const
inline

candidate explanations

◆ getPCMz()

float getPCMz ( ) const
inline

m/z of this charged peptide

◆ getSequence()

const String& getSequence ( ) const
inline

the peptide sequence (incl. mods)

◆ isDecoy()

bool isDecoy ( ) const
inline

is this a decoy feature (from a decoy protein)

◆ operator=() [1/2]

OSWPeptidePrecursor& operator= ( const OSWPeptidePrecursor rhs)
default

assignment operator

◆ operator=() [2/2]

OSWPeptidePrecursor& operator= ( OSWPeptidePrecursor &&  rhs)
default

move assignment operator

Member Data Documentation

◆ charge_

short charge_ {0}
private

◆ decoy_

bool decoy_ {false}
private

◆ features_

std::vector<OSWPeakGroup> features_
private

◆ precursor_mz_

float precursor_mz_ {0}
private

◆ seq_

String seq_
private