OpenMS  3.0.0
MRMFeaturePickerFile.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: Douglas McCloskey, Pasquale Domenico Colaianni $
32 // $Authors: Douglas McCloskey, Pasquale Domenico Colaianni $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h> // OPENMS_DLLAPI
39 #include <OpenMS/FORMAT/CsvFile.h>
40 #include <map>
41 
42 namespace OpenMS
43 {
61  class OPENMS_DLLAPI MRMFeaturePickerFile :
62  public CsvFile
63  {
64 public:
66  MRMFeaturePickerFile() = default;
68  ~MRMFeaturePickerFile() override = default;
69 
85  void load(
86  const String& filename,
87  std::vector<MRMFeaturePicker::ComponentParams>& cp_list,
88  std::vector<MRMFeaturePicker::ComponentGroupParams>& cgp_list
89  );
90 
91 protected:
102  bool extractParamsFromLine_(
103  const StringList& line,
104  const std::map<String, Size>& headers,
107  ) const;
108 
117  void setCastValue_(const String& key, const String& value, Param& params) const;
118  };
119 }
120 
OpenMS::MRMFeaturePicker::ComponentParams
Structure to contain information about a single component with its parameters.
Definition: MRMFeaturePicker.h:65
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MRMFeaturePickerFile
_MRMFeaturePickerFile_ loads components and components groups parameters from a .csv file.
Definition: MRMFeaturePickerFile.h:61
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::MRMFeaturePicker::ComponentGroupParams
Structure to contain information about a component group with its parameters.
Definition: MRMFeaturePicker.h:73
CsvFile.h
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::CsvFile
This class handles csv files. Currently only loading is implemented.
Definition: CsvFile.h:49
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
MRMFeaturePicker.h