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  More... | |
| virtual | ~IdentificationHit () | 
| destructor  More... | |
| IdentificationHit (const IdentificationHit &source) | |
| copy constructor  More... | |
| IdentificationHit & | operator= (const IdentificationHit &source) | 
| assignment operator  More... | |
| bool | operator== (const IdentificationHit &rhs) const | 
| Equality operator.  More... | |
| bool | operator!= (const IdentificationHit &rhs) const | 
| Inequality operator.  More... | |
| Accessors | |
| void | setId (const String &id) | 
| sets the identifier  More... | |
| const String & | getId () const | 
| returns the id  More... | |
| void | setCharge (Int charge) | 
| sets the charge state of the peptide  More... | |
| Int | getCharge () const | 
| returns the charge state  More... | |
| void | setCalculatedMassToCharge (DoubleReal mz) | 
| sets the calculated mass to charge ratio  More... | |
| DoubleReal | getCalculatedMassToCharge () const | 
| returns the calculated mass to charge ratio  More... | |
| void | setExperimentalMassToCharge (DoubleReal mz) | 
| sets the experimental mass to charge ratio  More... | |
| DoubleReal | getExperimentalMassToCharge () const | 
| returns the experimental mass to charge  More... | |
| void | setName (const String &name) | 
| sets the name  More... | |
| const String & | getName () const | 
| returns the name  More... | |
| void | setPassThreshold (bool pass) | 
| sets whether the peptide passed the threshold  More... | |
| bool | getPassThreshold () const | 
| returns whether the peptide passed the threshold  More... | |
| void | setRank (Int rank) | 
| set the rank of the peptide  More... | |
| Int | getRank () const | 
| returns the rank of the peptide  More... | |
|  Public Member Functions inherited from MetaInfoInterface | |
| MetaInfoInterface () | |
| constructor  More... | |
| MetaInfoInterface (const MetaInfoInterface &rhs) | |
| copy constructor  More... | |
| ~MetaInfoInterface () | |
| destructor  More... | |
| MetaInfoInterface & | operator= (const MetaInfoInterface &rhs) | 
| assignment operator  More... | |
| bool | operator== (const MetaInfoInterface &rhs) const | 
| Equality operator.  More... | |
| bool | operator!= (const MetaInfoInterface &rhs) const | 
| Equality operator.  More... | |
| const DataValue & | getMetaValue (const String &name) const | 
| returns the value corresponding to a string  More... | |
| const DataValue & | getMetaValue (UInt index) const | 
| returns the value corresponding to an index  More... | |
| bool | metaValueExists (const String &name) const | 
| returns if this MetaInfo is set  More... | |
| bool | metaValueExists (UInt index) const | 
| returns if this MetaInfo is set  More... | |
| void | setMetaValue (const String &name, const DataValue &value) | 
| sets the DataValue corresponding to a name  More... | |
| void | setMetaValue (UInt index, const DataValue &value) | 
| sets the DataValue corresponding to an index  More... | |
| void | removeMetaValue (const String &name) | 
| Removes the DataValue corresponding to nameif it exists.  More... | |
| void | removeMetaValue (UInt index) | 
| Removes the DataValue corresponding to indexif it exists.  More... | |
| void | getKeys (std::vector< String > &keys) const | 
| fills the given vector with a list of all keys for which a value is set  More... | |
| void | getKeys (std::vector< UInt > &keys) const | 
| fills the given vector with a list of all keys for which a value is set  More... | |
| bool | isMetaEmpty () const | 
| returns if the MetaInfo is empty  More... | |
| void | clearMetaInfo () | 
| removes all meta values  More... | |
| Protected Attributes | |
| String | id_ | 
| identifier  More... | |
| Int | charge_ | 
| peptide charge  More... | |
| DoubleReal | calculated_mass_to_charge_ | 
| calculated mass to charge ratio  More... | |
| DoubleReal | experimental_mass_to_charge_ | 
| experimental mass to charge ratio  More... | |
| String | name_ | 
| name  More... | |
| bool | pass_threshold_ | 
| pass threshold  More... | |
| Int | rank_ | 
| rank of the peptide  More... | |
|  Protected Attributes inherited from MetaInfoInterface | |
| MetaInfo * | meta_ | 
| pointer to the MetaInfo object. 0 by default  More... | |
| Additional Inherited Members | |
|  Static Public Member Functions inherited from MetaInfoInterface | |
| static MetaInfoRegistry & | metaRegistry () | 
| retuns a reference to the MetaInfoRegistry  More... | |
|  Protected Member Functions inherited from MetaInfoInterface | |
| void | createIfNotExists_ () | 
| creates the MetaInfo object if it does not exist  More... | |
Represents a object which can store the information of an analysisXML instance.
default constructor
| 
 | virtual | 
destructor
| IdentificationHit | ( | const IdentificationHit & | source | ) | 
copy constructor
| 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
| 
 | protected | 
calculated mass to charge ratio
| 
 | protected | 
peptide charge
| 
 | protected | 
experimental mass to charge ratio
| 
 | protected | 
identifier
| 
 | protected | 
name
| 
 | protected | 
pass threshold
| 
 | protected | 
rank of the peptide
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |