| OpenMS 2.5.0

Identification.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-2020.
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
37 #include <OpenMS/METADATA/MetaInfoInterface.h>
38 #include <OpenMS/DATASTRUCTURES/DateTime.h>
39 #include <OpenMS/METADATA/SpectrumIdentification.h>
40
41 #include <vector>
42
43 namespace OpenMS
44 {
52 class OPENMS_DLLAPI Identification :
53 public MetaInfoInterface
54 {
55 public:
56
58
59
61 Identification() = default;
63 Identification(const Identification & source) = default;
65 Identification(Identification&&) = default;
67 virtual ~Identification();
68
70 Identification & operator=(const Identification & source) = default;
72 Identification& operator=(Identification&&) & = default;
73
75 bool operator==(const Identification & rhs) const;
77 bool operator!=(const Identification & rhs) const;
79
81
82 void setCreationDate(const DateTime & date);
84
86 const DateTime & getCreationDate() const;
87
89 void setSpectrumIdentifications(const std::vector<SpectrumIdentification> & ids);
90
92 void addSpectrumIdentification(const SpectrumIdentification & id);
93
95 const std::vector<SpectrumIdentification> & getSpectrumIdentifications() const;
97 protected:
98
99 String id_;
100 DateTime creation_date_;
101 std::vector<SpectrumIdentification> spectrum_identifications_;
102
103 };
104
105 } //namespace OpenMS
106
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::Identification::creation_date_
DateTime creation_date_
Date and time the search was performed.
Definition: Identification.h:100
OpenMS::Identification
Represents a object which can store the information of an analysisXML instance.
Definition: Identification.h:52
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::Identification::id_
String id_
Identifier.
Definition: Identification.h:99
OpenMS::Identification::spectrum_identifications_
std::vector< SpectrumIdentification > spectrum_identifications_
Definition: Identification.h:101
OpenMS::SpectrumIdentification
Represents a object which can store the information of an analysisXML instance.
Definition: SpectrumIdentification.h:49
DateTime.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::DateTime
DateTime Class.
Definition: DateTime.h:54
SpectrumIdentification.h
MetaInfoInterface.h
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806