OpenMS  3.0.0
include/OpenMS/METADATA/ID/InputFile.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-2022.
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: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 #include <boost/multi_index_container.hpp>
40 #include <boost/multi_index/ordered_index.hpp>
41 #include <boost/multi_index/member.hpp>
42 
43 #include <set>
44 
45 namespace OpenMS
46 {
47  namespace IdentificationDataInternal
48  {
50  struct InputFile
51  {
53 
55 
56  std::set<String> primary_files;
57 
58  explicit InputFile(const String& name,
59  const String& experimental_design_id = "",
60  const std::set<String>& primary_files =
61  std::set<String>()):
64  {
65  }
66 
67  InputFile(const InputFile& other) = default;
68 
70  InputFile& merge(const InputFile& other)
71  {
72  if (experimental_design_id.empty())
73  {
75  }
76  else if (!other.experimental_design_id.empty() && experimental_design_id != other.experimental_design_id)
77  {
78  throw Exception::InvalidValue(__FILE__, __LINE__,
79  OPENMS_PRETTY_FUNCTION,
80  "Trying to overwrite InputFile experimental design id with conflicting value.",
82  }
83  primary_files.insert(other.primary_files.begin(),
84  other.primary_files.end());
85  return *this;
86  }
87  };
88 
89  typedef boost::multi_index_container<
90  InputFile,
91  boost::multi_index::indexed_by<
92  boost::multi_index::ordered_unique<boost::multi_index::member<
96 
97  }
98 }
OpenMS::IdentificationDataInternal::InputFile::InputFile
InputFile(const String &name, const String &experimental_design_id="", const std::set< String > &primary_files=std::set< String >())
Definition: include/OpenMS/METADATA/ID/InputFile.h:58
OpenMS::IdentificationDataInternal::InputFiles
boost::multi_index_container< InputFile, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::member< InputFile, String, &InputFile::name > > > > InputFiles
Definition: include/OpenMS/METADATA/ID/InputFile.h:94
OpenMS::Exception::InvalidValue
Invalid value exception.
Definition: Exception.h:327
OpenMS::String
A more convenient string class.
Definition: String.h:58
InputFile
OpenMS::InputFile InputFile
Definition: SwathTabWidget.h:143
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::IdentificationDataInternal::IteratorWrapper< InputFiles::iterator >
OpenMS::IdentificationDataInternal::InputFile::merge
InputFile & merge(const InputFile &other)
Merge in data from another object.
Definition: include/OpenMS/METADATA/ID/InputFile.h:70
OpenMS::IdentificationDataInternal::InputFile::experimental_design_id
String experimental_design_id
Definition: include/OpenMS/METADATA/ID/InputFile.h:54
OpenMS::IdentificationDataInternal::InputFile::primary_files
std::set< String > primary_files
Definition: include/OpenMS/METADATA/ID/InputFile.h:56
OpenMS::IdentificationDataInternal::InputFileRef
IteratorWrapper< InputFiles::iterator > InputFileRef
Definition: include/OpenMS/METADATA/ID/InputFile.h:95
OpenMS::IdentificationDataInternal::InputFile
Information about input files that were processed.
Definition: include/OpenMS/METADATA/ID/InputFile.h:50
String.h
OpenMS::IdentificationDataInternal::InputFile::name
String name
Definition: include/OpenMS/METADATA/ID/InputFile.h:52