ScanWindow Struct Reference

Scan window description. More...

#include <OpenMS/METADATA/ScanWindow.h>

Inheritance diagram for ScanWindow:

Collaboration diagram for ScanWindow:

Public Member Functions
	ScanWindow ()=default
	Default constructor.
	ScanWindow (const ScanWindow &)=default
	Copy constructor.
	ScanWindow (ScanWindow &&)=default
	Move constructor.
	~ScanWindow ()=default
	Destructor.
bool	operator== (const ScanWindow &source) const
	Equality operator.
bool	operator!= (const ScanWindow &source) const
	Equality operator.
ScanWindow &	operator= (const ScanWindow &)=default
	Assignment operator.
ScanWindow &	operator= (ScanWindow &&) &=default
	Move assignment operator.
Public Member Functions inherited from MetaInfoInterface
	MetaInfoInterface ()=default
	Constructor.
	MetaInfoInterface (const MetaInfoInterface &rhs)
	Copy constructor.
	MetaInfoInterface (MetaInfoInterface &&) noexcept
	Move constructor.
	~MetaInfoInterface ()
	Destructor.
MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator.
MetaInfoInterface &	operator= (MetaInfoInterface &&) noexcept
	Move assignment operator.
void	swap (MetaInfoInterface &rhs)
	Swap contents.
bool	operator== (const MetaInfoInterface &rhs) const
	Equality operator.
bool	operator!= (const MetaInfoInterface &rhs) const
	Equality operator.
const DataValue &	getMetaValue (const String &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.
DataValue	getMetaValue (const String &name, const DataValue &default_value) const
	Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found.
DataValue	getMetaValue (UInt index, const DataValue &default_value) const
	Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
bool	metaValueExists (const String &name) const
	Returns whether an entry with the given name exists.
bool	metaValueExists (UInt index) const
	Returns whether an entry with the given index exists.
void	setMetaValue (const String &name, const DataValue &value)
	Sets the DataValue corresponding to a name.
void	setMetaValue (UInt index, const DataValue &value)
	Sets the DataValue corresponding to an index.
void	removeMetaValue (const String &name)
	Removes the DataValue corresponding to name if it exists.
void	removeMetaValue (UInt index)
	Removes the DataValue corresponding to index if it exists.
void	addMetaValues (const MetaInfoInterface &from)
void	getKeys (std::vector< String > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
void	getKeys (std::vector< UInt > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
bool	isMetaEmpty () const
	Returns if the MetaInfo is empty.
void	clearMetaInfo ()
	Removes all meta values.

Public Attributes
double	begin = 0.0
	Begin of the window.
double	end = 0.0
	End of the window.

Additional Inherited Members
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	Returns a reference to the MetaInfoRegistry.
Protected Member Functions inherited from MetaInfoInterface
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

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 ( )

default

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.