| OpenMS 2.5.0

MetaInfoDescription.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: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/String.h>
38 #include <OpenMS/METADATA/DataProcessing.h>
39 #include <OpenMS/METADATA/MetaInfoInterface.h>
40
41 namespace OpenMS
42 {
48 class OPENMS_DLLAPI MetaInfoDescription :
49 public MetaInfoInterface
50 {
51 public:
53 MetaInfoDescription() = default;
55 MetaInfoDescription(const MetaInfoDescription &) = default;
57 MetaInfoDescription(MetaInfoDescription&&) = default;
59 ~MetaInfoDescription();
60
62 MetaInfoDescription & operator=(const MetaInfoDescription &) = default;
64 MetaInfoDescription& operator=(MetaInfoDescription&&) & = default;
65
67 bool operator==(const MetaInfoDescription & rhs) const;
68
70 const String & getName() const;
72 void setName(const String & name);
73
75 const std::vector<ConstDataProcessingPtr> & getDataProcessing() const;
77 std::vector<DataProcessingPtr> & getDataProcessing();
79 void setDataProcessing(const std::vector<DataProcessingPtr> & data_processing);
80
81 protected:
82 String comment_;
83 String name_;
84 std::vector<DataProcessingPtr> data_processing_;
85 };
86 } // namespace OpenMS
87
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MetaInfoDescription
Description of the meta data arrays of MSSpectrum.
Definition: MetaInfoDescription.h:48
DataProcessing.h
OpenMS::MetaInfoDescription::name_
String name_
Definition: MetaInfoDescription.h:83
String.h
OpenMS::MetaInfoDescription::data_processing_
std::vector< DataProcessingPtr > data_processing_
Definition: MetaInfoDescription.h:84
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
MetaInfoInterface.h
OpenMS::MetaInfoDescription::comment_
String comment_
Definition: MetaInfoDescription.h:82
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