| OpenMS 2.5.0

Public Member Functions | Protected Attributes | List of all members
Product Class Reference
Metadata

Product meta information. More...

`#include <OpenMS/METADATA/Product.h>`

Inheritance diagram for Product:

## Public Member Functions

| Product ()=default
| Constructor. More...
| Product (const Product &)=default
| Copy constructor. More...
| Product (Product &&)=default
| Move constructor. More...
| ~Product () override=default
| Destructor. More...
Product & | operator= (const Product &)=default
| Assignment operator. More...
Product & | operator= (Product &&) &=default
| Move assignment operator. More...
bool | operator== (const Product &rhs) const
| Equality operator. More...
bool | operator!= (const Product &rhs) const
| Equality operator. More...
double | getMZ () const
| returns the target m/z More...
void | setMZ (double mz)
| sets the target m/z More...
double | getIsolationWindowLowerOffset () const
| returns the lower offset from the target m/z More...
void | setIsolationWindowLowerOffset (double bound)
| sets the lower offset from the target m/z More...
double | getIsolationWindowUpperOffset () const
| returns the upper offset from the target m/z More...
void | setIsolationWindowUpperOffset (double bound)
| sets the upper offset from the target m/z More...
Public Member Functions inherited from CVTermList
| CVTermList ()=default
| Defaults constructor. More...
| CVTermList (const CVTermList &)=default
| Copy constructor. More...
| CVTermList (CVTermList &&) noexcept
| Move constructor. More...
virtual | ~CVTermList ()
| Destructor. More...
CVTermList & | operator= (const CVTermList &rhs) &=default
| Assignment operator. More...
CVTermList & | operator= (CVTermList &&) &=default
| Move 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...
void | consumeCVTerms (const Map< String, std::vector< CVTerm > > &cv_term_map)
| merges the given map into the member map, no duplicate checking 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 (MetaInfoInterface &&) noexcept
| Move constructor. More...
| ~MetaInfoInterface ()
| Destructor. More...
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs)
| Assignment operator. More...
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept
| Move 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 DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not found. More...
bool | metaValueExists (const String &name) const
| Returns whether an entry with the given name exists. More...
bool | metaValueExists (UInt index) const
| Returns whether an entry with the given index exists. 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 `name` if it exists. More...
void | removeMetaValue (UInt index)
| Removes the DataValue corresponding to `index` if 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

double | mz_ = 0.0
double | window_low_ = 0.0
double | window_up_ = 0.0
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 ()
| Returns a reference to the MetaInfoRegistry. More...
Protected Member Functions inherited from MetaInfoInterface
void | createIfNotExists_ ()
| Creates the MetaInfo object if it does not exist. More...

## Detailed Description

Product meta information.

This class describes the product isolation window for special scan types, such as MRM.

## Constructor & Destructor Documentation

## ◆ Product() [1/3]

Product | ( |  | ) |

default

Constructor.

## ◆ Product() [2/3]

Product | ( | const Product & |  | ) |

default

Copy constructor.

## ◆ Product() [3/3]

Product | ( | Product && |  | ) |

default

Move constructor.

## ◆ ~Product()

~Product | ( |  | ) |

override default

Destructor.

## Member Function Documentation

## ◆ getIsolationWindowLowerOffset()

double getIsolationWindowLowerOffset | ( |  | ) | const

returns the lower offset from the target m/z

## ◆ getIsolationWindowUpperOffset()

double getIsolationWindowUpperOffset | ( |  | ) | const

returns the upper offset from the target m/z

## ◆ getMZ()

double getMZ | ( |  | ) | const

returns the target m/z

## ◆ operator!=()

bool operator!= | ( | const Product & | rhs | ) | const

Equality operator.

## ◆ operator=() [1/2]

Product& operator= | ( | const Product & |  | ) |

default

Assignment operator.

## ◆ operator=() [2/2]

Product& operator= | ( | Product && |  | ) | &

default

Move assignment operator.

## ◆ operator==()

bool operator== | ( | const Product & | rhs | ) | const

Equality operator.

## ◆ setIsolationWindowLowerOffset()

void setIsolationWindowLowerOffset | ( | double | bound | ) |

sets the lower offset from the target m/z

## ◆ setIsolationWindowUpperOffset()

void setIsolationWindowUpperOffset | ( | double | bound | ) |

sets the upper offset from the target m/z

## ◆ setMZ()

void setMZ | ( | double | mz | ) |

sets the target m/z

Referenced by ChromatogramTools::convertSpectraToChromatograms(), ChromatogramExtractor::prepareSpectra_(), and ChromatogramExtractor::return_chromatogram().

## Member Data Documentation

## ◆ mz_

double mz_ = 0.0

protected

## ◆ window_low_

double window_low_ = 0.0

protected

## ◆ window_up_

double window_up_ = 0.0

protected