OpenMS  3.0.0
ExternalProcess.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
39 
40 #include <QtCore/QObject>
41 
42 #include <functional> // for std::function
43 
44 class QProcess; // forward declare to avoid header include
45 class QString;
46 class QStringList;
47 
48 namespace OpenMS
49 {
50 
62  class OPENMS_DLLAPI ExternalProcess
63  : public QObject
64  {
65  Q_OBJECT
66 
67  public:
69  enum class RETURNSTATE
70  {
71  SUCCESS,
72  NONZERO_EXIT,
73  CRASH,
74  FAILED_TO_START
75  };
76 
78  enum class IO_MODE
79  {
80  NO_IO,
81  READ_ONLY,
82  WRITE_ONLY,
83  READ_WRITE
84  };
85 
88 
90  ExternalProcess(std::function<void(const String&)> callbackStdOut, std::function<void(const String&)> callbackStdErr);
91 
93  ~ExternalProcess() override ;
94 
96  void setCallbacks(std::function<void(const String&)> callbackStdOut, std::function<void(const String&)> callbackStdErr);
97 
109  RETURNSTATE run(const QString& exe, const QStringList& args, const QString& working_dir, const bool verbose, String& error_msg, IO_MODE io_mode = IO_MODE::READ_WRITE);
110 
114  ExternalProcess::RETURNSTATE run(const QString& exe, const QStringList& args, const QString& working_dir, const bool verbose, IO_MODE io_mode = IO_MODE::READ_WRITE);
115 
116  private slots:
117  void processStdOut_();
118  void processStdErr_();
119 
120  private:
122  std::function<void(const String&)> callbackStdOut_;
123  std::function<void(const String&)> callbackStdErr_;
124  };
125 } // ns OpenMS
OpenMS::ExternalProcess
A wrapper around QProcess to conveniently start an external program and forward its outputs.
Definition: ExternalProcess.h:62
QObject
OpenMS::TOPPBase
Base class for TOPP applications.
Definition: TOPPBase.h:147
OpenMS::ExternalProcess::qp_
QProcess * qp_
pointer to avoid including the QProcess header here (it's huge)
Definition: ExternalProcess.h:121
OpenMS::ExternalProcess::callbackStdOut_
std::function< void(const String &)> callbackStdOut_
Definition: ExternalProcess.h:122
OpenMS::MzMLFile::store
void store(const String &filename, const PeakMap &map) const
Stores a map in an MzML file.
InternalCalibration.h
OpenMS::MZTrafoModel::setCoefficients
void setCoefficients(const MZTrafoModel &rhs)
Copy model coefficients from another model.
OpenMS::MzMLFile
File adapter for MzML files.
Definition: MzMLFile.h:57
OpenMS::String
A more convenient string class.
Definition: String.h:58
MzMLFile.h
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:70
OpenMS::IntList
std::vector< Int > IntList
Vector of signed integers.
Definition: ListUtils.h:55
OpenMS::InternalCalibration
A mass recalibration method using linear/quadratic interpolation (robust/weighted) of given reference...
Definition: InternalCalibration.h:62
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::MzMLFile::load
void load(const String &filename, PeakMap &map)
Loads a map from a MzML file. Spectra and chromatograms are sorted by default (this can be disabled u...
TransformationXMLFile.h
QProcess
OpenMS::InternalCalibration::applyTransformation
static void applyTransformation(std::vector< Precursor > &pcs, const MZTrafoModel &trafo)
Transform a precursor's m/z.
OpenMS::ExternalProcess::RETURNSTATE
RETURNSTATE
result of calling an external executable
Definition: ExternalProcess.h:69
OpenMS::DataProcessing::CALIBRATION
Calibration of m/z positions.
Definition: DataProcessing.h:69
OpenMS::ExternalProcess::IO_MODE
IO_MODE
Open mode for the process.
Definition: ExternalProcess.h:78
OpenMS::ExternalProcess::callbackStdErr_
std::function< void(const String &)> callbackStdErr_
Definition: ExternalProcess.h:123
main
int main(int argc, const char **argv)
Definition: INIFileEditor.cpp:71
OpenMS::Internal::ClassTest::verbose
int verbose
Verbosity level ( "-v" is 1 and "-V" is 2 )
OpenMS::MZTrafoModel
Create and apply models of a mass recalibration function.
Definition: MZTrafoModel.h:64
String.h
OpenMS::ProgressLogger::setLogType
void setLogType(LogType type) const
Sets the progress log that should be used. The default type is NONE!
TOPPBase.h