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

Description of the meta data arrays of MSSpectrum. More...

#include <OpenMS/METADATA/MetaInfoDescription.h>

Inheritance diagram for MetaInfoDescription:
MetaInfoInterface MSChromatogram< PeakT >::FloatDataArray MSChromatogram< PeakT >::IntegerDataArray MSChromatogram< PeakT >::StringDataArray MSSpectrum< PeakT >::FloatDataArray MSSpectrum< PeakT >::IntegerDataArray MSSpectrum< PeakT >::StringDataArray

Public Member Functions

 MetaInfoDescription ()
 Constructor. More...
 
 MetaInfoDescription (const MetaInfoDescription &source)
 Copy constructor. More...
 
 ~MetaInfoDescription ()
 Destructor. More...
 
MetaInfoDescriptionoperator= (const MetaInfoDescription &source)
 Assignment operator. More...
 
bool operator== (const MetaInfoDescription &rhs) const
 Equality operator. More...
 
const StringgetName () const
 returns the name of the peak annotations More...
 
void setName (const String &name)
 sets the name of the peak annotations More...
 
const std::vector< DataProcessing > & getDataProcessing () const
 returns a const reference to the description of the applied processing More...
 
std::vector< DataProcessing > & getDataProcessing ()
 returns a mutable reference to the description of the applied processing More...
 
void setDataProcessing (const std::vector< DataProcessing > &data_processing)
 sets the description of the applied processing 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 comment_
 
String name_
 
std::vector< DataProcessingdata_processing_
 
- 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

Description of the meta data arrays of MSSpectrum.

Constructor & Destructor Documentation

Constructor.

Copy constructor.

Destructor.

Member Function Documentation

const std::vector<DataProcessing>& getDataProcessing ( ) const

returns a const reference to the description of the applied processing

std::vector<DataProcessing>& getDataProcessing ( )

returns a mutable reference to the description of the applied processing

const String& getName ( ) const

returns the name of the peak annotations

MetaInfoDescription& operator= ( const MetaInfoDescription source)

Assignment operator.

bool operator== ( const MetaInfoDescription rhs) const

Equality operator.

void setDataProcessing ( const std::vector< DataProcessing > &  data_processing)

sets the description of the applied processing

void setName ( const String name)

sets the name of the peak annotations

Member Data Documentation

String comment_
protected
std::vector<DataProcessing> data_processing_
protected
String name_
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:56 using doxygen 1.8.9.1