| OpenMS 2.5.0

Public Member Functions | Public Attributes | List of all members
ScanWindow Struct Reference
Metadata

Scan window description. More...

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

Inheritance diagram for ScanWindow:

## Public Member Functions

| ScanWindow ()=default
| Default constructor. More...
| ScanWindow (const ScanWindow &)=default
| Copy constructor. More...
| ScanWindow (ScanWindow &&)=default
| Move constructor. More...
| ~ScanWindow ()
| Destructor. More...
bool | operator== (const ScanWindow &source) const
| Equality operator. More...
bool | operator!= (const ScanWindow &source) const
| Equality operator. More...
ScanWindow & | operator= (const ScanWindow &)=default
| Assignment operator. More...
ScanWindow & | operator= (ScanWindow &&) &=default
| Move assignment operator. 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...

## Public Attributes

double | begin = 0.0
| Begin of the window. More...
double | end = 0.0
| End of the window. 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...
Protected Attributes inherited from MetaInfoInterface
MetaInfo * | meta_
| Pointer to the MetaInfo object (0 by default) More...

## Detailed Description

Scan window description.

## Constructor & Destructor Documentation

## ◆ ScanWindow() [1/3]

ScanWindow | ( |  | ) |

default

Default constructor.

## ◆ ScanWindow() [2/3]

ScanWindow | ( | const ScanWindow & |  | ) |

default

Copy constructor.

## ◆ ScanWindow() [3/3]

ScanWindow | ( | ScanWindow && |  | ) |

default

Move constructor.

## ◆ ~ScanWindow()

~ScanWindow | ( |  | ) |

inline

Destructor.

## Member Function Documentation

## ◆ operator!=()

bool operator!= | ( | const ScanWindow & | source | ) | const

Equality operator.

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

ScanWindow& operator= | ( | const ScanWindow & |  | ) |

default

Assignment operator.

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

ScanWindow& operator= | ( | ScanWindow && |  | ) | &

default

Move assignment operator.

## ◆ operator==()

bool operator== | ( | const ScanWindow & | source | ) | const

Equality operator.

## Member Data Documentation

## ◆ begin

double begin = 0.0

Begin of the window.

## ◆ end

double end = 0.0

End of the window.