OpenMS  3.0.0
PythonModuleRequirement.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 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
38 
39 #include <QWidget>
40 
41 namespace Ui
42 {
44 }
45 
46 namespace OpenMS
47 {
48  namespace Internal
49  {
52  class OPENMS_GUI_DLLAPI PythonModuleRequirement : public QWidget
53  {
54  Q_OBJECT
55 
56  public:
57  explicit PythonModuleRequirement(QWidget* parent = nullptr);
59 
61  void setTitle(const QString& title);
62 
64  void setRequiredModules(const QStringList& m);
65 
67  void setFreeText(const QString& text);
68 
70  bool isReady() const { return is_ready_;};
71 
72 
73  signals:
75  void valueChanged(QStringList& valid_modules, QStringList& missing_modules);
76 
77 
78  public slots:
80  void validate(const QString& python_exe);
81 
82  private:
83  QStringList required_modules_;
84  QString info_text_;
85  bool is_ready_ = false;
86 
88  };
89 
90  } // ns Internal
91 } // ns OpenMS
92 
93 // this is required to allow Ui_SwathTabWidget (auto UIC'd from .ui) to have a PythonModuleRequirement member
OpenMS::Internal::ClassTest::validate
bool validate(const std::vector< std::string > &file_names)
Validates the given files against the XML schema (if available)
OpenMS::Internal::PythonModuleRequirement::required_modules_
QStringList required_modules_
list of modules which are needed (order might be important – know your Python...)
Definition: PythonModuleRequirement.h:83
QWidget
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Ui
Definition: SwathWizardBase.h:62
OpenMS::Internal::PythonModuleRequirement::info_text_
QString info_text_
additional text to display for the user
Definition: PythonModuleRequirement.h:84
OpenMS::Internal::PythonModuleRequirement
Definition: PythonModuleRequirement.h:52
OpenMS::Internal::PythonModuleRequirement::ui_
Ui::PythonModuleRequirement * ui_
Definition: PythonModuleRequirement.h:87
OpenMS::Internal::PythonModuleRequirement::isReady
bool isReady() const
are all modules present?
Definition: PythonModuleRequirement.h:70
PythonModuleRequirement
OpenMS::Internal::PythonModuleRequirement PythonModuleRequirement
Definition: PythonModuleRequirement.h:94