Representation of chromatogram settings, e.g. SRM/MRM chromatograms. More...
#include <OpenMS/METADATA/ChromatogramSettings.h>
Public Types | |
| enum | ChromatogramType { MASS_CHROMATOGRAM = 0, TOTAL_ION_CURRENT_CHROMATOGRAM, SELECTED_ION_CURRENT_CHROMATOGRAM, BASEPEAK_CHROMATOGRAM, SELECTED_ION_MONITORING_CHROMATOGRAM, SELECTED_REACTION_MONITORING_CHROMATOGRAM, ELECTROMAGNETIC_RADIATION_CHROMATOGRAM, ABSORPTION_CHROMATOGRAM, EMISSION_CHROMATOGRAM } |
Public Member Functions | |
| ChromatogramSettings () | |
| Constructor. | |
| ChromatogramSettings (const ChromatogramSettings &source) | |
| Copy constructor. | |
| virtual | ~ChromatogramSettings () |
| Destructor. | |
| ChromatogramSettings & | operator= (const ChromatogramSettings &source) |
| bool | operator== (const ChromatogramSettings &rhs) const |
| Equality operator. | |
| bool | operator!= (const ChromatogramSettings &rhs) const |
| Equality operator. | |
| const String & | getNativeID () const |
| returns the native identifier for the spectrum, used by the acquisition software. | |
| void | setNativeID (const String &native_id) |
| sets the native identifier for the spectrum, used by the acquisition software. | |
| 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 Precursor & | getPrecursor () const |
| returns a const reference to the precursors | |
| Precursor & | getPrecursor () |
| returns a mutable reference to the precursors | |
| void | setPrecursor (const Precursor &precursor) |
| sets the precursors | |
| const Product & | getProduct () const |
| returns a const reference to the products | |
| Product & | getProduct () |
| returns a mutable reference to the products | |
| void | setProduct (const Product &product) |
| sets the products | |
| 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 | |
| void | setDataProcessing (const std::vector< DataProcessing > &data_processing) |
| sets the description of the applied processing | |
| ChromatogramType | getChromatogramType () const |
| returns the chromatogram type, e.g. a SRM chromatogram | |
| void | setChromatogramType (ChromatogramType type) |
| sets the chromatogram type | |
Protected Attributes | |
| String | native_id_ |
| String | comment_ |
| InstrumentSettings | instrument_settings_ |
| SourceFile | source_file_ |
| AcquisitionInfo | acquisition_info_ |
| Precursor | precursor_ |
| Product | product_ |
| std::vector< DataProcessing > | data_processing_ |
| ChromatogramType | type_ |
Detailed Description
Representation of chromatogram settings, e.g. SRM/MRM chromatograms.
It contains the metadata about chromatogram specific instrument settings, acquisition settings, description of the meta values used in the peaks and precursor info.
Member Enumeration Documentation
| enum ChromatogramType |
Constructor & Destructor Documentation
Constructor.
Referenced by MSChromatogram< ChromatogramPeakType >::clear().
| ChromatogramSettings | ( | const ChromatogramSettings & | source | ) |
Copy constructor.
| virtual ~ChromatogramSettings | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| const AcquisitionInfo& getAcquisitionInfo | ( | ) | const |
returns a const reference to the acquisition info
| AcquisitionInfo& getAcquisitionInfo | ( | ) |
returns a mutable reference to the acquisition info
| ChromatogramType getChromatogramType | ( | ) | const |
returns the chromatogram type, e.g. a SRM chromatogram
Referenced by MzMLHandler< MapType >::writeTo().
| const String& getComment | ( | ) | const |
returns the free-text comment
| 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
| InstrumentSettings& getInstrumentSettings | ( | ) |
returns a mutable reference to the instrument settings of the current spectrum
| const InstrumentSettings& getInstrumentSettings | ( | ) | const |
returns a const reference to the instrument settings of the current spectrum
| const String& getNativeID | ( | ) | const |
returns the native identifier for the spectrum, used by the acquisition software.
Referenced by MzMLHandler< MapType >::fillChromatogramData_(), and MzMLHandler< MapType >::writeTo().
| const Precursor& getPrecursor | ( | ) | const |
returns a const reference to the precursors
Referenced by MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::handleUserParam_(), MzMLHandler< MapType >::startElement(), and MzMLHandler< MapType >::writeTo().
| Precursor& getPrecursor | ( | ) |
returns a mutable reference to the precursors
| const Product& getProduct | ( | ) | const |
returns a const reference to the products
Referenced by MSChromatogram< ChromatogramPeakType >::getMZ(), MzMLHandler< MapType >::handleCVParam_(), MzMLHandler< MapType >::handleUserParam_(), and MzMLHandler< MapType >::writeTo().
| Product& getProduct | ( | ) |
returns a mutable reference to the products
| const SourceFile& getSourceFile | ( | ) | const |
returns a const reference to the source file
| SourceFile& getSourceFile | ( | ) |
returns a mutable reference to the source file
| bool operator!= | ( | const ChromatogramSettings & | rhs | ) | const |
Equality operator.
| ChromatogramSettings& operator= | ( | const ChromatogramSettings & | source | ) |
| bool operator== | ( | const ChromatogramSettings & | rhs | ) | const |
Equality operator.
| void setAcquisitionInfo | ( | const AcquisitionInfo & | acquisition_info | ) |
sets the acquisition info
| void setChromatogramType | ( | ChromatogramType | type | ) |
sets the chromatogram type
Referenced by MzMLHandler< MapType >::handleCVParam_().
| void setComment | ( | const String & | comment | ) |
sets the free-text comment
| void setDataProcessing | ( | const std::vector< DataProcessing > & | data_processing | ) |
sets the description of the applied processing
Referenced by MzMLHandler< MapType >::startElement().
| void setInstrumentSettings | ( | const InstrumentSettings & | instrument_settings | ) |
sets the instrument settings of the current spectrum
| void setNativeID | ( | const String & | native_id | ) |
sets the native identifier for the spectrum, used by the acquisition software.
Referenced by MzMLHandler< MapType >::startElement().
| void setPrecursor | ( | const Precursor & | precursor | ) |
sets the precursors
Referenced by MzMLHandler< MapType >::startElement().
| void setProduct | ( | const Product & | product | ) |
sets the products
Referenced by MzMLHandler< MapType >::startElement().
| void setSourceFile | ( | const SourceFile & | source_file | ) |
sets the source file
Referenced by MzMLHandler< MapType >::startElement().
Member Data Documentation
AcquisitionInfo acquisition_info_ [protected] |
std::vector<DataProcessing> data_processing_ [protected] |
InstrumentSettings instrument_settings_ [protected] |
String native_id_ [protected] |
Precursor precursor_ [protected] |
SourceFile source_file_ [protected] |
ChromatogramType type_ [protected] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:55 using doxygen 1.7.1 |