OpenMS: MetaInfoDescription Class Reference

| OpenMS 2.5.0

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

Description of the meta data arrays of MSSpectrum. More...

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

Inheritance diagram for MetaInfoDescription:

## Public Member Functions

| MetaInfoDescription ()=default
| Constructor. More...
| MetaInfoDescription (const MetaInfoDescription &)=default
| Copy constructor. More...
| MetaInfoDescription (MetaInfoDescription &&)=default
| Move constructor. More...
| ~MetaInfoDescription ()
| Destructor. More...
MetaInfoDescription & | operator= (const MetaInfoDescription &)=default
| Assignment operator. More...
MetaInfoDescription & | operator= (MetaInfoDescription &&) &=default
| Move assignment operator. More...
bool | operator== (const MetaInfoDescription &rhs) const
| Equality operator. More...
const String & | getName () const
| returns the name of the peak annotations More...
void | setName (const String &name)
| sets the name of the peak annotations More...
const std::vector< ConstDataProcessingPtr > & | getDataProcessing () const
| returns a const reference to the description of the applied processing More...
std::vector< DataProcessingPtr > & | getDataProcessing ()
| returns a mutable reference to the description of the applied processing More...
void | setDataProcessing (const std::vector< DataProcessingPtr > &data_processing)
| sets the description of the applied processing 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

String | comment_
String | name_
std::vector< DataProcessingPtr > | data_processing_
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

Description of the meta data arrays of MSSpectrum.

## Constructor & Destructor Documentation

## ◆ MetaInfoDescription() [1/3]

MetaInfoDescription | ( |  | ) |

default

Constructor.

## ◆ MetaInfoDescription() [2/3]

MetaInfoDescription | ( | const MetaInfoDescription & |  | ) |

default

Copy constructor.

## ◆ MetaInfoDescription() [3/3]

MetaInfoDescription | ( | MetaInfoDescription && |  | ) |

default

Move constructor.

## ◆ ~MetaInfoDescription()

~MetaInfoDescription | ( |  | ) |

Destructor.

## Member Function Documentation

## ◆ getDataProcessing() [1/2]

const std::vector<ConstDataProcessingPtr>& getDataProcessing | ( |  | ) | const

returns a const reference to the description of the applied processing

## ◆ getDataProcessing() [2/2]

std::vector<DataProcessingPtr>& getDataProcessing | ( |  | ) |

returns a mutable reference to the description of the applied processing

## ◆ getName()

const String& getName | ( |  | ) | const

returns the name of the peak annotations

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

MetaInfoDescription& operator= | ( | const MetaInfoDescription & |  | ) |

default

Assignment operator.

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

MetaInfoDescription& operator= | ( | MetaInfoDescription && |  | ) | &

default

Move assignment operator.

## ◆ operator==()

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

Equality operator.

## ◆ setDataProcessing()

void setDataProcessing | ( | const std::vector< DataProcessingPtr > & | data_processing | ) |

sets the description of the applied processing

## ◆ setName()

void setName | ( | const String & | name | ) |

sets the name of the peak annotations

Referenced by OpenMS::processDriftTimeStack().

## Member Data Documentation

## ◆ comment_

String comment_

protected

## ◆ data_processing_

std::vector<DataProcessingPtr> data_processing_

protected

## ◆ name_

String name_

protected