Product meta information. More...
#include <OpenMS/METADATA/Product.h>
 
  
 | Public Member Functions | |
| Product () | |
| Constructor.  More... | |
| Product (const Product &source) | |
| Copy constructor.  More... | |
| ~Product () | |
| Destructor.  More... | |
| Product & | operator= (const Product &source) | 
| Assignment operator.  More... | |
| bool | operator== (const Product &rhs) const | 
| Equality operator.  More... | |
| bool | operator!= (const Product &rhs) const | 
| Equality operator.  More... | |
| DoubleReal | getMZ () const | 
| returns the target m/z  More... | |
| void | setMZ (DoubleReal mz) | 
| sets the target m/z  More... | |
| DoubleReal | getIsolationWindowLowerOffset () const | 
| returns the lower offset from the target m/z  More... | |
| void | setIsolationWindowLowerOffset (DoubleReal bound) | 
| sets the lower offset from the target m/z  More... | |
| DoubleReal | getIsolationWindowUpperOffset () const | 
| returns the upper offset from the target m/z  More... | |
| void | setIsolationWindowUpperOffset (DoubleReal bound) | 
| sets the upper offset from the target m/z  More... | |
|  Public Member Functions inherited from CVTermList | |
| CVTermList () | |
| Defaults constructor.  More... | |
| CVTermList (const CVTermList &rhs) | |
| Copy constructor.  More... | |
| virtual | ~CVTermList () | 
| Destructor.  More... | |
| CVTermList & | operator= (const CVTermList &rhs) | 
| Assignment operator.  More... | |
| void | setCVTerms (const std::vector< CVTerm > &terms) | 
| sets the CV terms  More... | |
| void | replaceCVTerm (const CVTerm &cv_term) | 
| replaces the specified CV term  More... | |
| void | replaceCVTerms (const std::vector< CVTerm > &cv_terms, const String &accession) | 
| replaces the specified CV terms using the given accession number  More... | |
| void | replaceCVTerms (const Map< String, std::vector< CVTerm > > &cv_term_map) | 
| replaces all cv terms with a map (can be obtained via getCVTerms)  More... | |
| const Map< String, std::vector < CVTerm > > & | getCVTerms () const | 
| returns the accession string of the term  More... | |
| void | addCVTerm (const CVTerm &term) | 
| adds a CV term  More... | |
| bool | operator== (const CVTermList &cv_term_list) const | 
| equality operator  More... | |
| bool | operator!= (const CVTermList &cv_term_list) const | 
| inequality operator  More... | |
| bool | hasCVTerm (const String &accession) const | 
| checks whether the term has a value  More... | |
| bool | empty () const | 
| return true if no terms are available  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 | |
| DoubleReal | mz_ | 
| DoubleReal | window_low_ | 
| DoubleReal | window_up_ | 
|  Protected Attributes inherited from CVTermList | |
| Map< String, std::vector < CVTerm > > | cv_terms_ | 
|  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... | |
Product meta information.
This class describes the product isolation window for special scan types, such as MRM.
| Product | ( | ) | 
Constructor.
| ~Product | ( | ) | 
Destructor.
| DoubleReal getIsolationWindowLowerOffset | ( | ) | const | 
returns the lower offset from the target m/z
Referenced by MzMLHandler< MapType >::writeProduct_().
| DoubleReal getIsolationWindowUpperOffset | ( | ) | const | 
returns the upper offset from the target m/z
Referenced by MzMLHandler< MapType >::writeProduct_().
| DoubleReal getMZ | ( | ) | const | 
returns the target m/z
Referenced by MSChromatogram< ChromatogramPeakType >::getMZ(), and MzMLHandler< MapType >::writeProduct_().
| bool operator!= | ( | const Product & | rhs | ) | const | 
Equality operator.
| bool operator== | ( | const Product & | rhs | ) | const | 
Equality operator.
| void setIsolationWindowLowerOffset | ( | DoubleReal | bound | ) | 
sets the lower offset from the target m/z
| void setIsolationWindowUpperOffset | ( | DoubleReal | bound | ) | 
sets the upper offset from the target m/z
| void setMZ | ( | DoubleReal | mz | ) | 
sets the target m/z
Referenced by ChromatogramTools::convertSpectraToChromatograms(), and ChromatogramExtractor::prepareSpectra_().
| 
 | protected | 
| 
 | protected | 
| 
 | protected | 
| OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:33 using doxygen 1.8.5 |