Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

SpectrumSettings.h (Maintainer: Marc Sturm)

Go to the documentation of this file.
00001 // -*- Mode: C++; tab-width: 2; -*-
00002 // vi: set ts=2:
00003 //
00004 // --------------------------------------------------------------------------
00005 //                   OpenMS Mass Spectrometry Framework
00006 // --------------------------------------------------------------------------
00007 //  Copyright (C) 2003-2008 -- Oliver Kohlbacher, Knut Reinert
00008 //
00009 //  This library is free software; you can redistribute it and/or
00010 //  modify it under the terms of the GNU Lesser General Public
00011 //  License as published by the Free Software Foundation; either
00012 //  version 2.1 of the License, or (at your option) any later version.
00013 // 
00014 //  This library is distributed in the hope that it will be useful,
00015 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017 //  Lesser General Public License for more details.
00018 //
00019 //  You should have received a copy of the GNU Lesser General Public
00020 //  License along with this library; if not, write to the Free Software
00021 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 //
00023 // --------------------------------------------------------------------------
00024 // $Maintainer: Marc Sturm $
00025 // --------------------------------------------------------------------------
00026 
00027 #ifndef OPENMS_METADATA_SPECTRUMSETTINGS_H
00028 #define OPENMS_METADATA_SPECTRUMSETTINGS_H
00029 
00030 #include <OpenMS/DATASTRUCTURES/String.h>
00031 #include <OpenMS/METADATA/InstrumentSettings.h>
00032 #include <OpenMS/METADATA/AcquisitionInfo.h>
00033 #include <OpenMS/METADATA/MetaInfoDescription.h>
00034 #include <OpenMS/METADATA/Precursor.h>
00035 #include <OpenMS/METADATA/PeptideIdentification.h>
00036 
00037 #include <map>
00038 #include <vector>
00039 
00040 namespace OpenMS 
00041 {
00054   class SpectrumSettings 
00055   {
00056     public:
00062       enum SpectrumType {UNKNOWN, PEAKS, RAWDATA,SIZE_OF_SPECTRUMTYPE};
00064       static const std::string NamesOfSpectrumType[SIZE_OF_SPECTRUMTYPE];
00065     
00067       SpectrumSettings();
00069       SpectrumSettings(const SpectrumSettings& source);
00071       ~SpectrumSettings();
00072       
00073       // Assignment operator
00074       SpectrumSettings& operator= (const SpectrumSettings& source);
00075 
00077       bool operator== (const SpectrumSettings& rhs) const;
00079       bool operator!= (const SpectrumSettings& rhs) const;
00080 
00086       SpectrumType getType() const;
00092       void setType(SpectrumType type);
00093 
00095       const String& getComment() const;
00097       void setComment(const String& comment);
00098       
00100       const InstrumentSettings& getInstrumentSettings() const;
00102       InstrumentSettings& getInstrumentSettings();
00104       void setInstrumentSettings(const InstrumentSettings& instrument_settings);
00105       
00107       const AcquisitionInfo& getAcquisitionInfo() const;
00109       AcquisitionInfo& getAcquisitionInfo();
00111       void setAcquisitionInfo(const AcquisitionInfo& acquisition_info);
00112       
00114       const SourceFile& getSourceFile() const;
00116       SourceFile& getSourceFile();
00118       void setSourceFile(const SourceFile& source_file);
00119       
00121       const std::map<String,MetaInfoDescription>& getMetaInfoDescriptions() const;
00123       std::map<String,MetaInfoDescription>& getMetaInfoDescriptions();
00125       void setMetaInfoDescriptions(const std::map<String,MetaInfoDescription>& meta_info_descriptions);
00126 
00128       const Precursor& getPrecursor() const;
00130       Precursor& getPrecursor();
00132       void setPrecursor(const Precursor& precursor);
00133       
00135       const std::vector<PeptideIdentification>& getPeptideIdentifications() const;        
00137       std::vector<PeptideIdentification>& getPeptideIdentifications();
00139       void setPeptideIdentifications(const std::vector<PeptideIdentification>& identifications);  
00140 
00141     protected:
00142       SpectrumType type_;
00143       String comment_;
00144       InstrumentSettings instrument_settings_;
00145       SourceFile source_file_;
00146       AcquisitionInfo acquisition_info_;
00147       std::map<String,MetaInfoDescription> meta_info_descriptions_;
00148       Precursor precursor_;
00149       std::vector<PeptideIdentification> identification_;
00150   };
00151 
00153   std::ostream& operator << (std::ostream& os, const SpectrumSettings& spec);
00154 
00155 } // namespace OpenMS
00156 
00157 #endif // OPENMS_METADATA_SPECTRUMSETTINGS_H

Generated Tue Apr 1 15:36:38 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1