AcquisitionInfo Class Reference

Description of the combination of raw data to a single spectrum. More...

#include <OpenMS/METADATA/AcquisitionInfo.h>

Inheritance diagram for AcquisitionInfo:

Collaboration diagram for AcquisitionInfo:

Public Member Functions
	AcquisitionInfo ()=default
	Constructor.
	AcquisitionInfo (const AcquisitionInfo &)=default
	Copy constructor.
	AcquisitionInfo (AcquisitionInfo &&)=default
	Move constructor.
	~AcquisitionInfo ()=default
	Destructor.
AcquisitionInfo &	operator= (const AcquisitionInfo &)=default
	Assignment operator.
AcquisitionInfo &	operator= (AcquisitionInfo &&) &=default
	Move assignment operator.
bool	operator== (const AcquisitionInfo &rhs) const
	Equality operator.
bool	operator!= (const AcquisitionInfo &rhs) const
	Equality operator.
const String &	getMethodOfCombination () const
	returns the method of combination
void	setMethodOfCombination (const String &method_of_combination)
	sets the method of combination
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.

Protected Attributes
Export methods from private base std::vector<Acquisition>
String	method_of_combination_
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

Private Types
typedef std::vector< Acquisition >	ContainerType

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.

Detailed Description

Description of the combination of raw data to a single spectrum.

Specification for combining raw scans ( Acquisition ) into a single spectrum. A list of acquisitions from the original raw file can be specified.

Member Typedef Documentation

ContainerType

typedef std::vector<Acquisition> ContainerType

private

Constructor & Destructor Documentation

AcquisitionInfo() [1/3]

AcquisitionInfo ( )

default

Constructor.

AcquisitionInfo() [2/3]

AcquisitionInfo ( const AcquisitionInfo &  )

default

Copy constructor.

AcquisitionInfo() [3/3]

AcquisitionInfo ( AcquisitionInfo &&  )

default

Move constructor.

~AcquisitionInfo()

~AcquisitionInfo ( )

default

Destructor.

Member Function Documentation

getMethodOfCombination()

const String & getMethodOfCombination

(

)

const

returns the method of combination

operator!=()

bool operator!=

(

const AcquisitionInfo &

rhs

)

const

Equality operator.

operator=() [1/2]

AcquisitionInfo & operator= ( AcquisitionInfo &&  ) &

default

Move assignment operator.

operator=() [2/2]

AcquisitionInfo & operator= ( const AcquisitionInfo &  )

default

Assignment operator.

operator==()

bool operator==

(

const AcquisitionInfo &

rhs

)

const

Equality operator.

setMethodOfCombination()

void setMethodOfCombination

(

const String &

method_of_combination

)

sets the method of combination

Referenced by XMassFile::load().

Member Data Documentation

method_of_combination_

String method_of_combination_

protected