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

Scan window description. More...

#include <OpenMS/METADATA/ScanWindow.h>

Inheritance diagram for ScanWindow:
MetaInfoInterface

Public Member Functions

 ScanWindow ()
 Default constructor. More...
 
 ScanWindow (const ScanWindow &source)
 Copy constructor. More...
 
bool operator== (const ScanWindow &source) const
 Equality operator. More...
 
bool operator!= (const ScanWindow &source) const
 Equality operator. More...
 
ScanWindowoperator= (const ScanWindow &source)
 Assignment operator. More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 Constructor. More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 Copy constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (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 DataValuegetMetaValue (const String &name) const
 Returns the value corresponding to a string (or DataValue::EMPTY if not found) More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to an index (or 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
 Begin of the window. More...
 
double end
 End of the window. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 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
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Detailed Description

Scan window description.

Constructor & Destructor Documentation

◆ ScanWindow() [1/2]

Default constructor.

◆ ScanWindow() [2/2]

ScanWindow ( const ScanWindow source)

Copy constructor.

Member Function Documentation

◆ operator!=()

bool operator!= ( const ScanWindow source) const

Equality operator.

◆ operator=()

ScanWindow& operator= ( const ScanWindow source)

Assignment operator.

◆ operator==()

bool operator== ( const ScanWindow source) const

Equality operator.

Member Data Documentation

◆ begin

double begin

Begin of the window.

◆ end

double end

End of the window.