OpenMS
AcquisitionInfo.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 
39 
40 #include <vector>
41 
42 namespace OpenMS
43 {
52  class OPENMS_DLLAPI AcquisitionInfo :
53  private std::vector<Acquisition>,
54  public MetaInfoInterface
55  {
56 private:
57  typedef std::vector<Acquisition> ContainerType;
58 
59 public:
61  AcquisitionInfo() = default;
63  AcquisitionInfo(const AcquisitionInfo&) = default;
67  ~AcquisitionInfo() = default;
68 
73 
75  bool operator==(const AcquisitionInfo& rhs) const;
77  bool operator!=(const AcquisitionInfo& rhs) const;
78 
82  void setMethodOfCombination(const String& method_of_combination);
83 
85 
86  using ContainerType::operator[];
87  using ContainerType::begin;
88  using ContainerType::end;
89  using ContainerType::size;
90  using ContainerType::push_back;
91  using ContainerType::empty;
92  using ContainerType::back;
93  using ContainerType::insert;
94  using ContainerType::resize;
95 
96  using ContainerType::iterator;
97  using ContainerType::const_iterator;
99 
100 protected:
102 
103  };
104 } // namespace OpenMS
105 
Description of the combination of raw data to a single spectrum.
Definition: AcquisitionInfo.h:55
void setMethodOfCombination(const String &method_of_combination)
sets the method of combination
std::vector< Acquisition > ContainerType
Definition: AcquisitionInfo.h:57
AcquisitionInfo(AcquisitionInfo &&)=default
Move constructor.
const String & getMethodOfCombination() const
returns the method of combination
AcquisitionInfo & operator=(AcquisitionInfo &&) &=default
Move assignment operator.
AcquisitionInfo(const AcquisitionInfo &)=default
Copy constructor.
String method_of_combination_
Definition: AcquisitionInfo.h:101
AcquisitionInfo & operator=(const AcquisitionInfo &)=default
Assignment operator.
AcquisitionInfo()=default
Constructor.
bool operator==(const AcquisitionInfo &rhs) const
Equality operator.
bool operator!=(const AcquisitionInfo &rhs) const
Equality operator.
~AcquisitionInfo()=default
Destructor.
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48