vdat.gui.progress – Monitor the execution progress

Custom progress and status bar objects

class vdat.gui.progress.VDATProgressBar(parent=None)[source]

Bases: PyQt5.QtWidgets.QProgressBar

VDAT progress bar.

Custom slot
Name Signature Description
setup_bar() int setup the format, the maximum to the input value and the value to zero
update_bar() int, int, int, int update the value of the progress bar; only the second value used
reset_bar() bool if the input is True reset the progress bar
Parameters:
parent : PyQt5.QtWidgets.QWidget instance

the parent widget

setup_bar(max_)[source]

Setup the format, the maximum to the input value and the value to zero. Designed to be connected with the n_primaries signal from vdat.command_interpreter.signals

Parameters:
max_ : int

maximum value for the progress bar

update_bar(int_tot, int_done, int_skipped, int_fail)[source]

Set the value of the progress bar to int_done. Designed to be connected with the progress signal from vdat.command_interpreter.signals.

reset_bar(bool_global)[source]

If bool_global == True, reset the progress bar. Designed to be connected with the command_done signal from vdat.command_interpreter.signals.

class vdat.gui.progress.VDATStatusBar(parent=None)[source]

Bases: PyQt5.QtWidgets.QStatusBar

Customized status bar

Custom slot
Name Signature Description
running_command() int, str show a message with the input string
clear_message() bool if the input is True show the message “Done” for 3 seconds
Parameters:
parent : PyQt5.QtWidgets.QWidget instance

the parent widget

running_command(int_, str_)[source]

Show the input string. Designed to be connected with the command_string signal from vdat.command_interpreter.signals.

clear_message(global_)[source]

If bool_global == True, show “Done” for 3 seconds. Designed to be connected with the command_done signal from vdat.command_interpreter.signals.