| OpenMS 2.5.0

ExperimentalSettings.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/METADATA/Sample.h>
38 #include <OpenMS/METADATA/MetaInfoInterface.h>
39 #include <OpenMS/METADATA/HPLC.h>
40 #include <OpenMS/METADATA/SourceFile.h>
41 #include <OpenMS/METADATA/ContactPerson.h>
42 #include <OpenMS/METADATA/Instrument.h>
43 #include <OpenMS/METADATA/DocumentIdentifier.h>
44 #include <OpenMS/METADATA/ProteinIdentification.h>
45
46 #include <vector>
47
48 namespace OpenMS
49 {
59 class OPENMS_DLLAPI ExperimentalSettings :
60 public MetaInfoInterface,
61 public DocumentIdentifier
62 {
63 public:
64
66 ExperimentalSettings() = default;
68 ExperimentalSettings(const ExperimentalSettings &) = default;
70 ExperimentalSettings(ExperimentalSettings&&) = default;
72 ~ExperimentalSettings() override;
73
75 ExperimentalSettings & operator=(const ExperimentalSettings &) = default;
77 ExperimentalSettings& operator=(ExperimentalSettings&&) & = default;
78
80 bool operator==(const ExperimentalSettings & rhs) const;
82 bool operator!=(const ExperimentalSettings & rhs) const;
83
85 const Sample & getSample() const;
87 Sample & getSample();
89 void setSample(const Sample & sample);
90
92 const std::vector<SourceFile> & getSourceFiles() const;
94 std::vector<SourceFile> & getSourceFiles();
96 void setSourceFiles(const std::vector<SourceFile> & source_files);
97
99 const std::vector<ContactPerson> & getContacts() const;
101 std::vector<ContactPerson> & getContacts();
103 void setContacts(const std::vector<ContactPerson> & contacts);
104
106 const Instrument & getInstrument() const;
108 Instrument & getInstrument();
110 void setInstrument(const Instrument & instrument);
111
113 const HPLC & getHPLC() const;
115 HPLC & getHPLC();
117 void setHPLC(const HPLC & hplc);
118
120 const DateTime & getDateTime() const;
122 void setDateTime(const DateTime & date);
123
125 const String & getComment() const;
127 void setComment(const String & comment);
128
130 const std::vector<ProteinIdentification> & getProteinIdentifications() const;
132 std::vector<ProteinIdentification> & getProteinIdentifications();
134 void setProteinIdentifications(const std::vector<ProteinIdentification> & protein_identifications);
135
137 const String & getFractionIdentifier() const;
139 void setFractionIdentifier(const String & fraction_identifier);
140
141 protected:
142 Sample sample_;
143 std::vector<SourceFile> source_files_;
144 std::vector<ContactPerson> contacts_;
145 Instrument instrument_;
146 HPLC hplc_;
147 DateTime datetime_;
148 String comment_;
149 std::vector<ProteinIdentification> protein_identifications_;
150 String fraction_identifier_;
151 };
152
154 OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const ExperimentalSettings & exp);
155
156 } // namespace OpenMS
157
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
ProteinIdentification.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
DocumentIdentifier.h
Instrument.h
OpenMS::HPLC
Representation of a HPLC experiment.
Definition: HPLC.h:50
HPLC.h
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::Instrument
Description of a MS instrument.
Definition: Instrument.h:63
OpenMS::ExperimentalSettings::comment_
String comment_
Definition: ExperimentalSettings.h:148
OpenMS::Sample
Meta information about the sample.
Definition: Sample.h:59
OpenMS::ExperimentalSettings::contacts_
std::vector< ContactPerson > contacts_
Definition: ExperimentalSettings.h:144
OpenMS::ExperimentalSettings::protein_identifications_
std::vector< ProteinIdentification > protein_identifications_
Definition: ExperimentalSettings.h:149
OpenMS::DocumentIdentifier
Manage source document information.
Definition: DocumentIdentifier.h:55
OpenMS::ExperimentalSettings::source_files_
std::vector< SourceFile > source_files_
Definition: ExperimentalSettings.h:143
OpenMS::ExperimentalSettings::datetime_
DateTime datetime_
Definition: ExperimentalSettings.h:147
OpenMS::operator<<
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::DateTime
DateTime Class.
Definition: DateTime.h:54
SourceFile.h
Sample.h
OpenMS::ExperimentalSettings::instrument_
Instrument instrument_
Definition: ExperimentalSettings.h:145
OpenMS::ExperimentalSettings::fraction_identifier_
String fraction_identifier_
Definition: ExperimentalSettings.h:150
OpenMS::ExperimentalSettings::sample_
Sample sample_
Definition: ExperimentalSettings.h:142
ContactPerson.h
MetaInfoInterface.h
OpenMS::ExperimentalSettings::hplc_
HPLC hplc_
Definition: ExperimentalSettings.h:146
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