OpenMS
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-2023.
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>
39 #include <OpenMS/METADATA/HPLC.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;
73 
78 
80  bool operator==(const ExperimentalSettings & rhs) const;
82  bool operator!=(const ExperimentalSettings & rhs) const;
83 
85  const Sample & getSample() const;
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;
110  void setInstrument(const Instrument & instrument);
111 
113  const HPLC & getHPLC() const;
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:
143  std::vector<SourceFile> source_files_;
144  std::vector<ContactPerson> contacts_;
149  std::vector<ProteinIdentification> protein_identifications_;
151  };
152 
154  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const ExperimentalSettings & exp);
155 
156 } // namespace OpenMS
157 
DateTime Class.
Definition: DateTime.h:59
Manage source document information.
Definition: DocumentIdentifier.h:56
Description of the experimental settings.
Definition: ExperimentalSettings.h:62
void setSample(const Sample &sample)
sets the sample description
String comment_
Definition: ExperimentalSettings.h:148
const Sample & getSample() const
returns a const reference to the sample description
bool operator!=(const ExperimentalSettings &rhs) const
Equality operator.
const Instrument & getInstrument() const
returns a const reference to the MS instrument description
void setComment(const String &comment)
sets the free-text comment
bool operator==(const ExperimentalSettings &rhs) const
Equality operator.
std::vector< ContactPerson > & getContacts()
returns a mutable reference to the list of contact persons
Sample & getSample()
returns a mutable reference to the sample description
Sample sample_
Definition: ExperimentalSettings.h:142
void setContacts(const std::vector< ContactPerson > &contacts)
sets the list of contact persons
String fraction_identifier_
Definition: ExperimentalSettings.h:150
const HPLC & getHPLC() const
returns a const reference to the description of the HPLC run
ExperimentalSettings & operator=(const ExperimentalSettings &)=default
Assignment operator.
HPLC hplc_
Definition: ExperimentalSettings.h:146
std::vector< ProteinIdentification > & getProteinIdentifications()
returns a mutable reference to the protein ProteinIdentification vector
ExperimentalSettings & operator=(ExperimentalSettings &&)=default
Move assignment operator.
const String & getFractionIdentifier() const
returns fraction identifier
Instrument instrument_
Definition: ExperimentalSettings.h:145
void setProteinIdentifications(const std::vector< ProteinIdentification > &protein_identifications)
sets the protein ProteinIdentification vector
std::vector< SourceFile > source_files_
Definition: ExperimentalSettings.h:143
const std::vector< SourceFile > & getSourceFiles() const
returns a const reference to the source data file
void setInstrument(const Instrument &instrument)
sets the MS instrument description
void setFractionIdentifier(const String &fraction_identifier)
sets the fraction identifier
void setHPLC(const HPLC &hplc)
sets the description of the HPLC run
const std::vector< ProteinIdentification > & getProteinIdentifications() const
returns a const reference to the protein ProteinIdentification vector
const std::vector< ContactPerson > & getContacts() const
returns a const reference to the list of contact persons
ExperimentalSettings(ExperimentalSettings &&)=default
Move constructor.
Instrument & getInstrument()
returns a mutable reference to the MS instrument description
const String & getComment() const
returns the free-text comment
std::vector< ProteinIdentification > protein_identifications_
Definition: ExperimentalSettings.h:149
void setSourceFiles(const std::vector< SourceFile > &source_files)
sets the source data file
HPLC & getHPLC()
returns a mutable reference to the description of the HPLC run
void setDateTime(const DateTime &date)
sets the date the experiment was performed
std::vector< SourceFile > & getSourceFiles()
returns a mutable reference to the source data file
DateTime datetime_
Definition: ExperimentalSettings.h:147
const DateTime & getDateTime() const
returns the date the experiment was performed
std::vector< ContactPerson > contacts_
Definition: ExperimentalSettings.h:144
ExperimentalSettings(const ExperimentalSettings &)=default
Copy constructor.
ExperimentalSettings()=default
Constructor.
~ExperimentalSettings() override
Destructor.
Representation of a HPLC experiment.
Definition: HPLC.h:51
Description of a MS instrument.
Definition: Instrument.h:65
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
Meta information about the sample.
Definition: Sample.h:61
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)