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

ProteinHit Class Reference
[Metadata]

#include <OpenMS/METADATA/ProteinHit.h>

Inheritance diagram for ProteinHit:

MetaInfoInterface

List of all members.


Detailed Description

Representation of a protein hit.

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

Public Member Functions

ProteinHitoperator= (const ProteinHit &source)
 assignment operator
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
void setScore (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

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


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

ProteinHit& operator= ( const ProteinHit source  ) 

assignment operator

bool operator== ( const ProteinHit rhs  )  const

Equality operator.

bool operator!= ( const ProteinHit rhs  )  const

Inequality operator.

Real getScore (  )  const

returns the score of the protein hit

UInt getRank (  )  const

returns the rank of the protein hit

const String& getSequence (  )  const

returns the protein sequence

const String& getAccession (  )  const

returns the accession of the protein

void setScore ( 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


Member Data Documentation

Real score_ [protected]

the score of the protein hit

UInt rank_ [protected]

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

String accession_ [protected]

the protein identifier

String sequence_ [protected]

the amino acid sequence of the protein hit


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