Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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 More...
 
const DataValuegetMetaValue (UInt index) const
 returns the value corresponding to an index More...
 
bool metaValueExists (const String &name) const
 returns if this MetaInfo is set More...
 
bool metaValueExists (UInt index) const
 returns if this MetaInfo is set 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

typedef std::vector<Acquisition> ContainerType
private

Constructor & Destructor Documentation

Constructor.

AcquisitionInfo ( const AcquisitionInfo source)

Copy constructor.

Destructor.

Member Function Documentation

const String& getMethodOfCombination ( ) const

returns the method of combination

Referenced by MzMLHandler< MapType >::writeSpectrum_(), and MzDataHandler< MapType >::writeTo().

bool operator!= ( const AcquisitionInfo rhs) const

Equality operator.

AcquisitionInfo& operator= ( const AcquisitionInfo source)

Assignment operator.

bool operator== ( const AcquisitionInfo rhs) const

Equality operator.

void setMethodOfCombination ( const String method_of_combination)

Member Data Documentation

String method_of_combination_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:26 using doxygen 1.8.11