OpenMS  2.4.0
Public Member Functions | Protected Attributes | 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:
MetaInfoInterface

Public Member Functions

 AcquisitionInfo ()
 Constructor. More...
 
 AcquisitionInfo (const AcquisitionInfo &source)
 Copy constructor. More...
 
 ~AcquisitionInfo ()
 Destructor. More...
 
AcquisitionInfooperator= (const AcquisitionInfo &source)
 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 ()
 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...
 

Protected Attributes

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/2]

Constructor.

◆ AcquisitionInfo() [2/2]

AcquisitionInfo ( const AcquisitionInfo source)

Copy constructor.

◆ ~AcquisitionInfo()

Destructor.

Member Function Documentation

◆ getMethodOfCombination()

const String& getMethodOfCombination ( ) const

returns the method of combination

◆ operator!=()

bool operator!= ( const AcquisitionInfo rhs) const

Equality operator.

◆ operator=()

AcquisitionInfo& operator= ( const AcquisitionInfo source)

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