Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

PeptideHit Class Reference
[Metadata]

#include <OpenMS/METADATA/PeptideHit.h>

Inheritance diagram for PeptideHit:

MetaInfoInterface

List of all members.


Detailed Description

Representation of a peptide hit.

It contains the fields score, score_type, rank, and sequence.

Public Member Functions

PeptideHitoperator= (const PeptideHit &source)
 assignment operator
bool operator== (const PeptideHit &rhs) const
 Equality operator.
bool operator!= (const PeptideHit &rhs) const
 Inequality operator.
Constructors and Destructor


 PeptideHit ()
 default constructor
 PeptideHit (DoubleReal score, UInt rank, Int charge, const String &sequence)
 values constructor
 PeptideHit (const PeptideHit &source)
 copy constructor
virtual ~PeptideHit ()
 destructor
Accessors
Real getScore () const
 returns the score of the peptide hit
UInt getRank () const
 returns the rank of the peptide hit
String getSequence () const
 returns the peptide sequence without trailing or following spaces
Int getCharge () const
 returns the carge of the peptide
const std::vector< String > & getProteinAccessions () const
 returns the corresponding protein accessions
void setProteinAccessions (const std::vector< String > &accessions)
 sets the corresponding protein accessions
void setScore (DoubleReal score)
 sets the score of the peptide hit
void setRank (UInt newrank)
 sets the rank
void setSequence (const String &sequence)
 sets the peptide sequence
void setCharge (Int charge)
 sets the charge of the peptide
void addProteinAccession (const String &accession)
 adds an accession of a protein which contains this peptide hit
void setAABefore (char acid)
 sets the amino acid before the sequence
char getAABefore () const
 returns the amino acid before the sequence
void setAAAfter (char acid)
 sets the amino acid after the sequence
char getAAAfter () const
 returns the amino acid after the sequence

Protected Attributes

Real score_
 the score of the peptide hit
UInt rank_
 the position(rank) where the hit appeared in the hit list
Int charge_
 the charge of the peptide
String sequence_
 the amino acid sequence of the peptide hit
char aa_before_
 Amino acid before the sequence.
char aa_after_
 Amino acid after the sequence.
std::vector< Stringcorresponding_protein_accessions_
 the accessions of the corresponding proteins

Classes

class  ScoreLess
 Lesser predicate for scores of hits. More...
class  ScoreMore
 Greater predicate for scores of hits. More...


Constructor & Destructor Documentation

PeptideHit (  ) 

default constructor

PeptideHit ( DoubleReal  score,
UInt  rank,
Int  charge,
const String sequence 
)

values constructor

PeptideHit ( const PeptideHit source  ) 

copy constructor

virtual ~PeptideHit (  )  [virtual]

destructor


Member Function Documentation

PeptideHit& operator= ( const PeptideHit source  ) 

assignment operator

bool operator== ( const PeptideHit rhs  )  const

Equality operator.

bool operator!= ( const PeptideHit rhs  )  const

Inequality operator.

Real getScore (  )  const

returns the score of the peptide hit

UInt getRank (  )  const

returns the rank of the peptide hit

String getSequence (  )  const

returns the peptide sequence without trailing or following spaces

Int getCharge (  )  const

returns the carge of the peptide

const std::vector<String>& getProteinAccessions (  )  const

returns the corresponding protein accessions

void setProteinAccessions ( const std::vector< String > &  accessions  ) 

sets the corresponding protein accessions

void setScore ( DoubleReal  score  ) 

sets the score of the peptide hit

void setRank ( UInt  newrank  ) 

sets the rank

void setSequence ( const String sequence  ) 

sets the peptide sequence

void setCharge ( Int  charge  ) 

sets the charge of the peptide

void addProteinAccession ( const String accession  ) 

adds an accession of a protein which contains this peptide hit

void setAABefore ( char  acid  ) 

sets the amino acid before the sequence

char getAABefore (  )  const

returns the amino acid before the sequence

void setAAAfter ( char  acid  ) 

sets the amino acid after the sequence

char getAAAfter (  )  const

returns the amino acid after the sequence


Member Data Documentation

Real score_ [protected]

the score of the peptide hit

UInt rank_ [protected]

the position(rank) where the hit appeared in the hit list

Int charge_ [protected]

the charge of the peptide

String sequence_ [protected]

the amino acid sequence of the peptide hit

char aa_before_ [protected]

Amino acid before the sequence.

char aa_after_ [protected]

Amino acid after the sequence.

std::vector<String> corresponding_protein_accessions_ [protected]

the accessions of the corresponding proteins


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:46 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1