OpenMS
Loading...
Searching...
No Matches
FIAMSScheduler.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Svetlana Kutuzova, Douglas McCloskey $
6// $Authors: Svetlana Kutuzova, Douglas McCloskey $
7// --------------------------------------------------------------------------
8
9#pragma once
10
12#include <map>
13
14namespace OpenMS
15{
16class MzMLFile;
52class OPENMS_DLLAPI FIAMSScheduler
53 {
54public:
56 FIAMSScheduler() = default;
57
73 std::string filename,
74 std::string base_dir = "/",
75 std::string output_dir = "/",
76 bool load_cached_ = true
77 );
78
80 ~FIAMSScheduler() = default;
81
83 FIAMSScheduler(const FIAMSScheduler& cp) = default;
84
86 FIAMSScheduler& operator=(const FIAMSScheduler& fdp) = default;
87
98 void run();
99
101 const std::vector<std::map<std::string, std::string>>& getSamples();
102
104 const std::string& getBaseDir();
105
107 const std::string& getOutputDir();
108
109private:
117
118 std::string filename_;
119 std::string base_dir_;
120 std::string output_dir_;
122 std::vector<std::map<std::string, std::string>> samples_;
123 };
124} // namespace OpenMS
Batch driver for FIA-MS analyses. Dispatches each sample of a CSV-described batch to FIAMSDataProcess...
Definition FIAMSScheduler.h:53
void run()
Run the batch: process every sample loaded from the CSV.
void loadSamples_()
Parse the batch CSV at filename_ and populate samples_.
std::string filename_
CSV file describing the batch.
Definition FIAMSScheduler.h:118
const std::vector< std::map< std::string, std::string > > & getSamples()
Return the parsed batch as a vector of header-keyed std::map rows.
FIAMSScheduler(std::string filename, std::string base_dir="/", std::string output_dir="/", bool load_cached_=true)
Construct from a batch CSV and parse it immediately.
FIAMSScheduler & operator=(const FIAMSScheduler &fdp)=default
Copy assignment.
~FIAMSScheduler()=default
Default destructor.
std::vector< std::map< std::string, std::string > > samples_
Parsed CSV rows; populated by loadSamples_.
Definition FIAMSScheduler.h:122
bool load_cached_
Forwarded to FIAMSDataProcessor::run; reuse cached results when true.
Definition FIAMSScheduler.h:121
FIAMSScheduler()=default
Default-construct an empty scheduler (no samples loaded, paths set to defaults).
std::string base_dir_
Base directory for per-sample input paths (must end with a path separator).
Definition FIAMSScheduler.h:119
FIAMSScheduler(const FIAMSScheduler &cp)=default
Copy constructor.
const std::string & getBaseDir()
Return the base directory passed to the constructor.
std::string output_dir_
Base directory under which per-sample outputs are written (must end with a path separator).
Definition FIAMSScheduler.h:120
const std::string & getOutputDir()
Return the output directory passed to the constructor.
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19