Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Attributes | List of all members
Acquisition Class Reference

Information about one raw data spectrum that was combined with several other raw data spectra. More...

#include <OpenMS/METADATA/Acquisition.h>

Inheritance diagram for Acquisition:
MetaInfoInterface

Public Member Functions

 Acquisition ()
 Constructor. More...
 
 Acquisition (const Acquisition &source)
 Copy constructor. More...
 
 ~Acquisition ()
 Destructor. More...
 
Acquisitionoperator= (const Acquisition &source)
 Assignment operator. More...
 
bool operator== (const Acquisition &rhs) const
 Equality operator. More...
 
bool operator!= (const Acquisition &rhs) const
 Equality operator. More...
 
const StringgetIdentifier () const
 return the identifier/index/number of the acquisition More...
 
void setIdentifier (const String &identifier)
 sets the index/number of the scan 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 identifier_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 pointer to the MetaInfo object. 0 by default More...
 

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

Information about one raw data spectrum that was combined with several other raw data spectra.

Although this class is basically a string value, it is needed to store important meta info for each raw data scan.

Constructor & Destructor Documentation

Constructor.

Acquisition ( const Acquisition source)

Copy constructor.

Destructor.

Member Function Documentation

const String& getIdentifier ( ) const

return the identifier/index/number of the acquisition

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

bool operator!= ( const Acquisition rhs) const

Equality operator.

Acquisition& operator= ( const Acquisition source)

Assignment operator.

bool operator== ( const Acquisition rhs) const

Equality operator.

void setIdentifier ( const String identifier)

sets the index/number of the scan

Referenced by MzMLHandler< MapType >::startElement().

Member Data Documentation

String identifier_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 16:18:47 using doxygen 1.8.5