Represents a object which can store the information of an analysisXML instance. More...
#include <OpenMS/METADATA/IdentificationHit.h>
Public Member Functions | |
constructors,destructors,assignment operator | |
| IdentificationHit () | |
| default constructor | |
| virtual | ~IdentificationHit () |
| destructor | |
| IdentificationHit (const IdentificationHit &source) | |
| copy constructor | |
| IdentificationHit & | operator= (const IdentificationHit &source) |
| assignment operator | |
| bool | operator== (const IdentificationHit &rhs) const |
| Equality operator. | |
| bool | operator!= (const IdentificationHit &rhs) const |
| Inequality operator. | |
Accessors | |
| void | setId (const String &id) |
| sets the identifier | |
| const String & | getId () const |
| returns the id | |
| void | setCharge (Int charge) |
| sets the charge state of the peptide | |
| Int | getCharge () const |
| returns the charge state | |
| void | setCalculatedMassToCharge (DoubleReal mz) |
| sets the calculated mass to charge ratio | |
| DoubleReal | getCalculatedMassToCharge () const |
| returns the calculated mass to charge ratio | |
| void | setExperimentalMassToCharge (DoubleReal mz) |
| sets the experimental mass to charge ratio | |
| DoubleReal | getExperimentalMassToCharge () const |
| returns the experimental mass to charge | |
| void | setName (const String &name) |
| sets the name | |
| const String & | getName () const |
| returns the name | |
| void | setPassThreshold (bool pass) |
| sets whether the peptide passed the threshold | |
| bool | getPassThreshold () const |
| returns whether the peptide passed the threshold | |
| void | setRank (Int rank) |
| set the rank of the peptide | |
| Int | getRank () const |
| returns the rank of the peptide | |
Protected Attributes | |
| String | id_ |
| identifier | |
| Int | charge_ |
| peptide charge | |
| DoubleReal | calculated_mass_to_charge_ |
| calculated mass to charge ratio | |
| DoubleReal | experimental_mass_to_charge_ |
| experimental mass to charge ratio | |
| String | name_ |
| name | |
| bool | pass_threshold_ |
| pass threshold | |
| Int | rank_ |
| rank of the peptide | |
Detailed Description
Represents a object which can store the information of an analysisXML instance.
- Todo:
- docu (Andreas)
Constructor & Destructor Documentation
default constructor
| virtual ~IdentificationHit | ( | ) | [virtual] |
destructor
| IdentificationHit | ( | const IdentificationHit & | source | ) |
copy constructor
Member Function Documentation
| DoubleReal getCalculatedMassToCharge | ( | ) | const |
returns the calculated mass to charge ratio
| Int getCharge | ( | ) | const |
returns the charge state
| DoubleReal getExperimentalMassToCharge | ( | ) | const |
returns the experimental mass to charge
| const String& getId | ( | ) | const |
returns the id
| const String& getName | ( | ) | const |
returns the name
| bool getPassThreshold | ( | ) | const |
returns whether the peptide passed the threshold
| Int getRank | ( | ) | const |
returns the rank of the peptide
| bool operator!= | ( | const IdentificationHit & | rhs | ) | const |
Inequality operator.
| IdentificationHit& operator= | ( | const IdentificationHit & | source | ) |
assignment operator
| bool operator== | ( | const IdentificationHit & | rhs | ) | const |
Equality operator.
| void setCalculatedMassToCharge | ( | DoubleReal | mz | ) |
sets the calculated mass to charge ratio
| void setCharge | ( | Int | charge | ) |
sets the charge state of the peptide
| void setExperimentalMassToCharge | ( | DoubleReal | mz | ) |
sets the experimental mass to charge ratio
| void setId | ( | const String & | id | ) |
sets the identifier
| void setName | ( | const String & | name | ) |
sets the name
| void setPassThreshold | ( | bool | pass | ) |
sets whether the peptide passed the threshold
| void setRank | ( | Int | rank | ) |
set the rank of the peptide
Member Data Documentation
DoubleReal calculated_mass_to_charge_ [protected] |
calculated mass to charge ratio
DoubleReal experimental_mass_to_charge_ [protected] |
experimental mass to charge ratio
bool pass_threshold_ [protected] |
pass threshold
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1 |