OpenMS  2.6.0
Public Member Functions | Private Types | List of all members
AcquisitionInfo Class Reference

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

#include <OpenMS/METADATA/AcquisitionInfo.h>

Inheritance diagram for AcquisitionInfo:
[legend]
Collaboration diagram for AcquisitionInfo:
[legend]

Public Member Functions

 AcquisitionInfo ()=default
 Constructor. More...
 
 AcquisitionInfo (const AcquisitionInfo &)=default
 Copy constructor. More...
 
 AcquisitionInfo (AcquisitionInfo &&)=default
 Move constructor. More...
 
 ~AcquisitionInfo ()=default
 Destructor. More...
 
AcquisitionInfooperator= (const AcquisitionInfo &)=default
 Assignment operator. More...
 
AcquisitionInfooperator= (AcquisitionInfo &&) &=default
 Move assignment operator. More...
 
bool operator== (const AcquisitionInfo &rhs) const
 Equality operator. More...
 
bool operator!= (const AcquisitionInfo &rhs) const
 Equality operator. More...
 
const StringgetMethodOfCombination () const
 returns the method of combination More...
 
void setMethodOfCombination (const String &method_of_combination)
 sets the method of combination 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...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (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 DataValuegetMetaValue (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 DataValuegetMetaValue (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 addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one 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

Export methods from private base std::vector<Acquisition>
String method_of_combination_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Private Types

typedef std::vector< AcquisitionContainerType
 

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...
 

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