| OpenMS 2.5.0

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

Information about one raw data spectrum that was combined with several other raw data spectra. More...

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

Inheritance diagram for Acquisition:

## Public Member Functions

| Acquisition ()=default
| Constructor. More...
| Acquisition (const Acquisition &)=default
| Copy constructor. More...
| Acquisition (Acquisition &&)=default
| Move constructor. More...
| ~Acquisition ()=default
| Destructor. More...
Acquisition & | operator= (const Acquisition &)=default
| Assignment operator. More...
Acquisition & | operator= (Acquisition &&) &=default
| Move assignment operator. More...
bool | operator== (const Acquisition &rhs) const
| Equality operator. More...
bool | operator!= (const Acquisition &rhs) const
| Equality operator. More...
const String & | getIdentifier () const
| return the identifier/index/number of the acquisition More...
void | setIdentifier (const String &identifier)
| sets the index/number of the scan 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 | identifier_
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

Information about one raw data spectrum that was combined with several other raw data spectra.

Although this class is basically a string value, it is needed to store important meta info for each raw data scan.

## Constructor & Destructor Documentation

## ◆ Acquisition() [1/3]

Acquisition | ( |  | ) |

default

Constructor.

## ◆ Acquisition() [2/3]

Acquisition | ( | const Acquisition & |  | ) |

default

Copy constructor.

## ◆ Acquisition() [3/3]

Acquisition | ( | Acquisition && |  | ) |

default

Move constructor.

## ◆ ~Acquisition()

~Acquisition | ( |  | ) |

default

Destructor.

## Member Function Documentation

## ◆ getIdentifier()

const String& getIdentifier | ( |  | ) | const

return the identifier/index/number of the acquisition

## ◆ operator!=()

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

Equality operator.

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

Acquisition& operator= | ( | const Acquisition & |  | ) |

default

Assignment operator.

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

Acquisition& operator= | ( | Acquisition && |  | ) | &

default

Move assignment operator.

## ◆ operator==()

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

Equality operator.

## ◆ setIdentifier()

void setIdentifier | ( | const String & | identifier | ) |

sets the index/number of the scan

## Member Data Documentation

## ◆ identifier_

String identifier_

protected