OpenMS  3.0.0
SpectrumIdentification.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: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
49  class OPENMS_DLLAPI SpectrumIdentification :
50  public MetaInfoInterface
51  {
52 public:
53 
55 
56  SpectrumIdentification() = default;
59  virtual ~SpectrumIdentification();
65  SpectrumIdentification & operator=(const SpectrumIdentification &) = default;
67  SpectrumIdentification& operator=(SpectrumIdentification&&) & = default;
69  bool operator==(const SpectrumIdentification & rhs) const;
71  bool operator!=(const SpectrumIdentification & rhs) const;
73 
74  // @name Accessors
76  void setHits(const std::vector<IdentificationHit> & hits);
78 
80  void addHit(const IdentificationHit & hit);
81 
83  const std::vector<IdentificationHit> & getHits() const;
85 
86 protected:
87 
89  std::vector<IdentificationHit> hits_;
90  };
91 
92 } //namespace OpenMS
OpenMS::SpectrumIdentification::id_
String id_
Identifier.
Definition: SpectrumIdentification.h:88
OpenMS::String
A more convenient string class.
Definition: String.h:58
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
IdentificationHit.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::IdentificationHit
Represents a object which can store the information of an analysisXML instance.
Definition: IdentificationHit.h:48
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)
OpenMS::SpectrumIdentification
Represents a object which can store the information of an analysisXML instance.
Definition: SpectrumIdentification.h:49
MetaInfoInterface.h
OpenMS::SpectrumIdentification::hits_
std::vector< IdentificationHit > hits_
Single peptide hits.
Definition: SpectrumIdentification.h:89