OpenMS  3.0.0
IBSpectraFile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h>
39 
40 // boost shared_ptr
41 #include <boost/shared_ptr.hpp>
42 
43 namespace OpenMS
44 {
45 
46  // forward declaration
47  class ConsensusMap;
48  class String;
49  class IsobaricQuantitationMethod;
50  class AASequence;
51 
56  class OPENMS_DLLAPI IBSpectraFile
57  {
58 public:
62  IBSpectraFile();
63 
67  IBSpectraFile(const IBSpectraFile& other);
68 
72  IBSpectraFile& operator=(const IBSpectraFile& rhs);
73 
82  void store(const String& filename, const ConsensusMap& cm);
83 private:
84 
90  boost::shared_ptr<IsobaricQuantitationMethod> guessExperimentType_(const ConsensusMap& cm);
91 
97  StringList constructHeader_(const IsobaricQuantitationMethod& quantMethod);
98 
105  String getModifString_(const AASequence& sequence);
106  };
107 
108 }
109 
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::IBSpectraFile
Implements the export of consensusmaps into the IBSpectra format used by isobar to load quantificatio...
Definition: IBSpectraFile.h:56
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::IsobaricQuantitationMethod
Abstract base class describing an isobaric quantitation method in terms of the used channels and an i...
Definition: IsobaricQuantitationMethod.h:55
OpenMS::ConsensusMap
A container for consensus elements.
Definition: ConsensusMap.h:82
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::AASequence
Representation of a peptide/protein sequence.
Definition: AASequence.h:111
StringListUtils.h