Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Classes | Public Member Functions | Protected Attributes

ProteinHit Class Reference
[Metadata]

Representation of a protein hit. More...

#include <OpenMS/METADATA/ProteinHit.h>

Inheritance diagram for ProteinHit:
MetaInfoInterface

List of all members.

Classes

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

Public Member Functions

ProteinHitoperator= (const ProteinHit &source)
 assignment operator
ProteinHitoperator= (const MetaInfoInterface &source)
 assignment for MetaInfo
bool operator== (const ProteinHit &rhs) const
 Equality operator.
bool operator!= (const ProteinHit &rhs) const
 Inequality operator.
Constructors and Destructor

 ProteinHit ()
 default constructor
 ProteinHit (DoubleReal score, UInt rank, String accession, String sequence)
 values constructor
 ProteinHit (const ProteinHit &source)
 copy constructor
virtual ~ProteinHit ()
 destructor
Accessors

Real getScore () const
 returns the score of the protein hit
UInt getRank () const
 returns the rank of the protein hit
const StringgetSequence () const
 returns the protein sequence
const StringgetAccession () const
 returns the accession of the protein
DoubleReal getCoverage () const
 returns the coverage (in percent) of the protein hit based upon matched peptides
void setScore (const DoubleReal score)
 sets the score of the protein hit
void setRank (UInt newrank)
 sets the rank
void setSequence (const String &sequence)
 sets the protein sequence
void setAccession (const String &accession)
 sets the accession of the protein
void setCoverage (const DoubleReal coverage)
 sets the coverage (in percent) of the protein hit based upon matched peptides

Protected Attributes

Real score_
 the score of the protein hit
UInt rank_
 the position(rank) where the hit appeared in the hit list
String accession_
 the protein identifier
String sequence_
 the amino acid sequence of the protein hit
DoubleReal coverage_
 coverage of the protein based upon the matched peptide sequences

Detailed Description

Representation of a protein hit.

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


Constructor & Destructor Documentation

ProteinHit (  ) 

default constructor

ProteinHit ( DoubleReal  score,
UInt  rank,
String  accession,
String  sequence 
)

values constructor

ProteinHit ( const ProteinHit source  ) 

copy constructor

virtual ~ProteinHit (  )  [virtual]

destructor


Member Function Documentation

const String& getAccession (  )  const

returns the accession of the protein

DoubleReal getCoverage (  )  const

returns the coverage (in percent) of the protein hit based upon matched peptides

UInt getRank (  )  const

returns the rank of the protein hit

Real getScore (  )  const

returns the score of the protein hit

const String& getSequence (  )  const

returns the protein sequence

bool operator!= ( const ProteinHit rhs  )  const

Inequality operator.

ProteinHit& operator= ( const MetaInfoInterface source  ) 

assignment for MetaInfo

Reimplemented from MetaInfoInterface.

ProteinHit& operator= ( const ProteinHit source  ) 

assignment operator

bool operator== ( const ProteinHit rhs  )  const

Equality operator.

void setAccession ( const String accession  ) 

sets the accession of the protein

Referenced by DBAdapter::loadExperiment(), and MRMFeatureFinderScoring::pickExperiment().

void setCoverage ( const DoubleReal  coverage  ) 

sets the coverage (in percent) of the protein hit based upon matched peptides

void setRank ( UInt  newrank  ) 

sets the rank

Referenced by DBAdapter::loadExperiment().

void setScore ( const DoubleReal  score  ) 

sets the score of the protein hit

Referenced by DBAdapter::loadExperiment().

void setSequence ( const String sequence  ) 

sets the protein sequence

Referenced by DBAdapter::loadExperiment(), and MRMFeatureFinderScoring::pickExperiment().


Member Data Documentation

String accession_ [protected]

the protein identifier

DoubleReal coverage_ [protected]

coverage of the protein based upon the matched peptide sequences

UInt rank_ [protected]

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

Real score_ [protected]

the score of the protein hit

String sequence_ [protected]

the amino acid sequence of the protein hit


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1