blacs.plugins.progress_bar.Plugin

class blacs.plugins.progress_bar.Plugin(initial_settings)[source]

Bases: object

__init__(initial_settings)[source]

Methods

__init__(initial_settings)

clear_bar()

close()

get_callbacks()

get_menu_class()

get_next_thing()

Figure out what's going to happen next: a wait, a time marker, or a regular update.

get_notification_classes()

get_save_data()

get_setting_classes()

mainloop()

plugin_setup_complete(BLACS)

set_menu_instance(menu)

set_notification_instances(notifications)

update_bar_style([marker, wait, previous])

Update the bar's style to reflect the next marker or wait, according to self.next_marker_index or self.next_wait_index.

update_bar_value([marker, wait])

Update the progress bar with the current time elapsed.

Attributes

on_science_over

Class wrapping a callable.

on_science_starting

Class wrapping a callable.

clear_bar()[source]
close()[source]
get_callbacks()[source]
get_menu_class()[source]
get_next_thing()[source]

Figure out what’s going to happen next: a wait, a time marker, or a regular update. Return a string saying which, and a float saying how long from now it will occur. If the thing has already happened but not been taken into account by our processing yet, then return zero for the time.

get_notification_classes()[source]
get_save_data()[source]
get_setting_classes()[source]
mainloop()[source]
on_science_over

Class wrapping a callable. At present only differs from a regular function in that it has a “priority” attribute - lower numbers means higher priority. If there are multiple callbacks triggered by the same event, they will be returned in order of priority by get_callbacks

on_science_starting

Class wrapping a callable. At present only differs from a regular function in that it has a “priority” attribute - lower numbers means higher priority. If there are multiple callbacks triggered by the same event, they will be returned in order of priority by get_callbacks

plugin_setup_complete(BLACS)[source]
set_menu_instance(menu)[source]
set_notification_instances(notifications)[source]
update_bar_style(marker=False, wait=False, previous=False)[source]

Update the bar’s style to reflect the next marker or wait, according to self.next_marker_index or self.next_wait_index. If previous=True, instead update to reflect the current marker or wait.

update_bar_value(marker=False, wait=False)[source]

Update the progress bar with the current time elapsed. If marker or wait is true, then use the exact time at which the next marker or wait is defined, rather than the current time as returned by time.time()