OpenMS
SwathTabWidget Class Reference

A multi-tabbed widget for the SwathWizard offering setting of parameters, input-file specification and running Swath and more. More...

#include <OpenMS/VISUAL/DIALOGS/SwathTabWidget.h>

Inheritance diagram for SwathTabWidget:
[legend]
Collaboration diagram for SwathTabWidget:
[legend]

Public Member Functions

 SwathTabWidget (QWidget *parent=nullptr)
 
 ~SwathTabWidget ()
 
StringList getMzMLInputFiles () const
 
QStringList getPyProphetOutputFileNames () const
 

Private Slots

void on_run_swath_clicked ()
 
void on_edit_advanced_parameters_clicked ()
 
void broadcastNewCWD_ (const QString &new_cwd)
 update the current working directory for all file input fields More...
 
void on_btn_runPyProphet_clicked ()
 
void on_btn_pyresults_clicked ()
 
void on_pushButton_clicked ()
 

Private Member Functions

bool findPythonScript_ (const String &path_to_python_exe, String &script_name)
 
void updateSwathParamFromWidgets_ ()
 collect all parameters throughout the Wizard's controls and update 'swath_param_' More...
 
void updateWidgetsfromSwathParam_ ()
 update Widgets given a param object More...
 
QString getCurrentOutDir_ () const
 where to write OSW output and pyProphet output More...
 
std::vector< std::pair< String, bool > > getPyProphetInputFiles () const
 
void checkPyProphetInput_ ()
 check if input to pyProphet is already present in the output directory of OSW More...
 
void writeLog_ (const QString &text, const QColor &color="#000000", bool new_section=false)
 fill osw_result_files_ according to the the currently specified input mzMLs More...
 
void writeLog_ (const String &text, const QColor &color="#000000", bool new_section=false)
 convenient overload for String More...
 
bool checkOSWInputReady_ ()
 

Private Attributes

Ui::SwathTabWidget * ui
 
Param swath_param_
 the global Swath parameters which will be passed to OpenSwathWorkflow.exe, once updated with parameters the Wizard holds separately More...
 
Param swath_param_wizard_
 small selection of important parameters which the user can directly change in the Wizard More...
 
StringList osw_result_files_
 list of .osw files produced by OSW which are currently available More...
 
ExternalProcessMBox ep_
 to run external programs and pipe their output into our log More...
 

Friends

template<typename >
class WizardGUILock
 

Detailed Description

A multi-tabbed widget for the SwathWizard offering setting of parameters, input-file specification and running Swath and more.

Constructor & Destructor Documentation

◆ SwathTabWidget()

SwathTabWidget ( QWidget parent = nullptr)
explicit

◆ ~SwathTabWidget()

Member Function Documentation

◆ broadcastNewCWD_

void broadcastNewCWD_ ( const QString &  new_cwd)
privateslot

update the current working directory for all file input fields

◆ checkOSWInputReady_()

bool checkOSWInputReady_ ( )
private

Ensure all input widgets are filled with data by the user to run OpenSwathWorkflow If anything is missing: show a Messagebox and return false.

◆ checkPyProphetInput_()

void checkPyProphetInput_ ( )
private

check if input to pyProphet is already present in the output directory of OSW

◆ findPythonScript_()

bool findPythonScript_ ( const String path_to_python_exe,
String script_name 
)
private

find the path of a Script, given the location of python(.exe). E.g. pyprophet.exe or feature_alignment.py Returns true on success, with the full path in script_name

◆ getCurrentOutDir_()

QString getCurrentOutDir_ ( ) const
private

where to write OSW output and pyProphet output

◆ getMzMLInputFiles()

StringList getMzMLInputFiles ( ) const

◆ getPyProphetInputFiles()

std::vector<std::pair<String, bool> > getPyProphetInputFiles ( ) const
private

translate the current list of input mzMLs and the current output directory of OSW to a list of expected OSW output files == pyProphet input files The bool indicates if the file is already present

◆ getPyProphetOutputFileNames()

QStringList getPyProphetOutputFileNames ( ) const

◆ on_btn_pyresults_clicked

void on_btn_pyresults_clicked ( )
privateslot

◆ on_btn_runPyProphet_clicked

void on_btn_runPyProphet_clicked ( )
privateslot

◆ on_edit_advanced_parameters_clicked

void on_edit_advanced_parameters_clicked ( )
privateslot

◆ on_pushButton_clicked

void on_pushButton_clicked ( )
privateslot

◆ on_run_swath_clicked

void on_run_swath_clicked ( )
privateslot

◆ updateSwathParamFromWidgets_()

void updateSwathParamFromWidgets_ ( )
private

collect all parameters throughout the Wizard's controls and update 'swath_param_'

◆ updateWidgetsfromSwathParam_()

void updateWidgetsfromSwathParam_ ( )
private

update Widgets given a param object

◆ writeLog_() [1/2]

void writeLog_ ( const QString &  text,
const QColor &  color = "#000000",
bool  new_section = false 
)
private

fill osw_result_files_ according to the the currently specified input mzMLs

append text to the log tab

Parameters
textThe text to write
colorColor of the text
new_sectionStart a new block with a date and time

◆ writeLog_() [2/2]

void writeLog_ ( const String text,
const QColor &  color = "#000000",
bool  new_section = false 
)
private

convenient overload for String

Friends And Related Function Documentation

◆ WizardGUILock

friend class WizardGUILock
friend

Member Data Documentation

◆ ep_

ExternalProcessMBox ep_
private

to run external programs and pipe their output into our log

◆ osw_result_files_

StringList osw_result_files_
private

list of .osw files produced by OSW which are currently available

◆ swath_param_

Param swath_param_
private

the global Swath parameters which will be passed to OpenSwathWorkflow.exe, once updated with parameters the Wizard holds separately

◆ swath_param_wizard_

Param swath_param_wizard_
private

small selection of important parameters which the user can directly change in the Wizard

◆ ui

Ui::SwathTabWidget* ui
private