#include <OpenMS/METADATA/SpectrumSettings.h>
It contains the metadata about spectrum specific instrument settings, acquisition settings, description of the meta values used in the peaks and precursor info.
Precursor info should only be used if this spectrum is a tandem-MS spectrum. The precursor spectrum is the first spectrum before this spectrum, that has a lower MS-level than the current spectrum.
Public Types | |
enum | SpectrumType { UNKNOWN, PEAKS, RAWDATA, SIZE_OF_SPECTRUMTYPE } |
spectrum type More... | |
Public Member Functions | |
SpectrumSettings () | |
Constructor. | |
SpectrumSettings (const SpectrumSettings &source) | |
Copy constructor. | |
~SpectrumSettings () | |
Destructor. | |
SpectrumSettings & | operator= (const SpectrumSettings &source) |
bool | operator== (const SpectrumSettings &rhs) const |
Equality operator. | |
bool | operator!= (const SpectrumSettings &rhs) const |
Equality operator. | |
SpectrumType | getType () const |
returns the spectrum type | |
void | setType (SpectrumType type) |
sets the spectrum type | |
const String & | getComment () const |
returns the free-text comment | |
void | setComment (const String &comment) |
sets the free-text comment | |
const InstrumentSettings & | getInstrumentSettings () const |
returns a const reference to the instrument settings of the current spectrum | |
InstrumentSettings & | getInstrumentSettings () |
returns a mutable reference to the instrument settings of the current spectrum | |
void | setInstrumentSettings (const InstrumentSettings &instrument_settings) |
sets the instrument settings of the current spectrum | |
const AcquisitionInfo & | getAcquisitionInfo () const |
returns a const reference to the acquisition info | |
AcquisitionInfo & | getAcquisitionInfo () |
returns a mutable reference to the acquisition info | |
void | setAcquisitionInfo (const AcquisitionInfo &acquisition_info) |
sets the acquisition info | |
const SourceFile & | getSourceFile () const |
returns a const reference to the source file | |
SourceFile & | getSourceFile () |
returns a mutable reference to the source file | |
void | setSourceFile (const SourceFile &source_file) |
sets the source file | |
const std::map< String, MetaInfoDescription > & | getMetaInfoDescriptions () const |
returns a const reference to the description of the meta values used in the peaks | |
std::map< String, MetaInfoDescription > & | getMetaInfoDescriptions () |
returns a mutable reference to the description of the meta values used in the peaks | |
void | setMetaInfoDescriptions (const std::map< String, MetaInfoDescription > &meta_info_descriptions) |
sets the description of the meta values used in the peaks | |
const Precursor & | getPrecursor () const |
returns a const reference to the precursor | |
Precursor & | getPrecursor () |
returns a mutable reference to the precursor | |
void | setPrecursor (const Precursor &precursor) |
sets the precursor | |
const std::vector < PeptideIdentification > & | getPeptideIdentifications () const |
returns a const reference to the PeptideIdentification vector | |
std::vector < PeptideIdentification > & | getPeptideIdentifications () |
returns a mutable reference to the PeptideIdentification vector | |
void | setPeptideIdentifications (const std::vector< PeptideIdentification > &identifications) |
sets the PeptideIdentification vector | |
Static Public Attributes | |
static const std::string | NamesOfSpectrumType [SIZE_OF_SPECTRUMTYPE] |
Names of spectrum types. | |
Protected Attributes | |
SpectrumType | type_ |
String | comment_ |
InstrumentSettings | instrument_settings_ |
SourceFile | source_file_ |
AcquisitionInfo | acquisition_info_ |
std::map< String, MetaInfoDescription > | meta_info_descriptions_ |
Precursor | precursor_ |
std::vector < PeptideIdentification > | identification_ |
enum SpectrumType |
spectrum type
If set to unknown see SpectrumType of the ProcessingMethod ( in MSExperiment ).
SpectrumSettings | ( | ) |
Constructor.
SpectrumSettings | ( | const SpectrumSettings & | source | ) |
Copy constructor.
~SpectrumSettings | ( | ) |
Destructor.
SpectrumSettings& operator= | ( | const SpectrumSettings & | source | ) |
bool operator== | ( | const SpectrumSettings & | rhs | ) | const |
Equality operator.
bool operator!= | ( | const SpectrumSettings & | rhs | ) | const |
Equality operator.
SpectrumType getType | ( | ) | const |
returns the spectrum type
If the type is 'UNKNOWN', a general type for all spectra of an experiment might be stored in the ProcessingMethod instance of an ExperimentalSettings .
void setType | ( | SpectrumType | type | ) |
sets the spectrum type
If the type is 'UNKNOWN', a general type for all spectra of an experiment might be stored in the ProcessingMethod instance of an ExperimentalSettings .
const String& getComment | ( | ) | const |
returns the free-text comment
void setComment | ( | const String & | comment | ) |
sets the free-text comment
const InstrumentSettings& getInstrumentSettings | ( | ) | const |
returns a const reference to the instrument settings of the current spectrum
InstrumentSettings& getInstrumentSettings | ( | ) |
returns a mutable reference to the instrument settings of the current spectrum
void setInstrumentSettings | ( | const InstrumentSettings & | instrument_settings | ) |
sets the instrument settings of the current spectrum
const AcquisitionInfo& getAcquisitionInfo | ( | ) | const |
returns a const reference to the acquisition info
AcquisitionInfo& getAcquisitionInfo | ( | ) |
returns a mutable reference to the acquisition info
void setAcquisitionInfo | ( | const AcquisitionInfo & | acquisition_info | ) |
sets the acquisition info
const SourceFile& getSourceFile | ( | ) | const |
returns a const reference to the source file
SourceFile& getSourceFile | ( | ) |
returns a mutable reference to the source file
void setSourceFile | ( | const SourceFile & | source_file | ) |
sets the source file
const std::map<String,MetaInfoDescription>& getMetaInfoDescriptions | ( | ) | const |
returns a const reference to the description of the meta values used in the peaks
std::map<String,MetaInfoDescription>& getMetaInfoDescriptions | ( | ) |
returns a mutable reference to the description of the meta values used in the peaks
void setMetaInfoDescriptions | ( | const std::map< String, MetaInfoDescription > & | meta_info_descriptions | ) |
sets the description of the meta values used in the peaks
const Precursor& getPrecursor | ( | ) | const |
returns a const reference to the precursor
Precursor& getPrecursor | ( | ) |
returns a mutable reference to the precursor
void setPrecursor | ( | const Precursor & | precursor | ) |
sets the precursor
const std::vector<PeptideIdentification>& getPeptideIdentifications | ( | ) | const |
returns a const reference to the PeptideIdentification vector
std::vector<PeptideIdentification>& getPeptideIdentifications | ( | ) |
returns a mutable reference to the PeptideIdentification vector
void setPeptideIdentifications | ( | const std::vector< PeptideIdentification > & | identifications | ) |
sets the PeptideIdentification vector
const std::string NamesOfSpectrumType[SIZE_OF_SPECTRUMTYPE] [static] |
Names of spectrum types.
SpectrumType type_ [protected] |
InstrumentSettings instrument_settings_ [protected] |
SourceFile source_file_ [protected] |
AcquisitionInfo acquisition_info_ [protected] |
std::map<String,MetaInfoDescription> meta_info_descriptions_ [protected] |
Precursor precursor_ [protected] |
std::vector<PeptideIdentification> identification_ [protected] |
Generated Tue Apr 1 15:36:47 2008 -- using doxygen 1.5.4 | OpenMS / TOPP 1.1 |