KiCad PCB EDA Suite
|
A progress reporter interface for use in multi-threaded environments. More...
#include <progress_reporter.h>
Public Member Functions | |
PROGRESS_REPORTER () | |
PROGRESS_REPORTER (const PROGRESS_REPORTER &)=delete | |
virtual | ~PROGRESS_REPORTER () |
virtual void | SetNumPhases (int aNumPhases)=0 |
Set the number of phases. | |
virtual void | AddPhases (int aNumPhases)=0 |
virtual void | BeginPhase (int aPhase)=0 |
Initialize the aPhase virtual zone of the dialog progress bar. | |
virtual void | AdvancePhase ()=0 |
Use the next available virtual zone of the dialog progress bar. | |
virtual void | AdvancePhase (const wxString &aMessage)=0 |
Use the next available virtual zone of the dialog progress bar and updates the message. | |
virtual void | Report (const wxString &aMessage)=0 |
Display aMessage in the progress bar dialog. | |
virtual void | SetCurrentProgress (double aProgress)=0 |
Set the progress value to aProgress (0..1). | |
virtual void | SetMaxProgress (int aMaxProgress)=0 |
Fix the value that gives the 100 percent progress bar length (inside the current virtual zone). | |
virtual void | AdvanceProgress ()=0 |
Increment the progress bar length (inside the current virtual zone). | |
virtual bool | KeepRefreshing (bool aWait=false)=0 |
Update the UI (if any). | |
virtual void | SetTitle (const wxString &aTitle)=0 |
Change the title displayed on the window caption. | |
virtual bool | IsCancelled () const =0 |
A progress reporter interface for use in multi-threaded environments.
The various advancement and message methods can be called from sub-threads. The KeepRefreshing method MUST be called only from the main thread (primarily a MSW requirement, which won't allow access to UI objects allocated from a separate thread).
Definition at line 38 of file progress_reporter.h.
|
inline |
Definition at line 42 of file progress_reporter.h.
Referenced by CLI_PROGRESS_REPORTER::GetInstance(), PROGRESS_REPORTER(), and PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE().
|
delete |
References PROGRESS_REPORTER().
|
inlinevirtual |
Definition at line 47 of file progress_reporter.h.
|
pure virtual |
Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
|
pure virtual |
Use the next available virtual zone of the dialog progress bar.
Implemented in BACKGROUND_JOB_REPORTER, CLI_PROGRESS_REPORTER, DIALOG_PCM_PROGRESS, JOBS_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
Referenced by DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), DRC_TOOL::RunTests(), and ERC_TESTER::RunTests().
|
pure virtual |
Use the next available virtual zone of the dialog progress bar and updates the message.
Implemented in CLI_PROGRESS_REPORTER, DIALOG_DRC, DIALOG_ERC, and PROGRESS_REPORTER_BASE.
|
pure virtual |
Increment the progress bar length (inside the current virtual zone).
Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
Referenced by CN_CONNECTIVITY_ALGO::Build(), and BOARD::CacheTriangulation().
|
pure virtual |
Initialize the aPhase virtual zone of the dialog progress bar.
Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
|
pure virtual |
|
pure virtual |
Update the UI (if any).
Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
Referenced by CN_CONNECTIVITY_ALGO::Build(), CONNECTIVITY_DATA::Build(), BOARD::CacheTriangulation(), PLUGIN_CONTENT_MANAGER::DownloadToStream(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), CADSTAR_ARCHIVE_PARSER::LoadArchiveFile(), UPDATE_MANAGER::PostRequest(), SYMBOL_LIBRARY_MANAGER::Preload(), and CONNECTION_GRAPH::Recalculate().
|
pure virtual |
Display aMessage in the progress bar dialog.
Implemented in BACKGROUND_JOB_REPORTER, CLI_PROGRESS_REPORTER, DIALOG_ERC, JOBS_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
Referenced by JOBS_PROGRESS_REPORTER::AdvanceJob(), CONNECTIVITY_DATA::Build(), BOARD::CacheTriangulation(), PLUGIN_CONTENT_MANAGER::DownloadToStream(), UPDATE_MANAGER::PostRequest(), and JOBS_PROGRESS_REPORTER::Report().
|
pure virtual |
Set the progress value to aProgress (0..1).
Implemented in CLI_PROGRESS_REPORTER, CONSOLE_PROGRESS_REPORTER, CONSOLE_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
Referenced by CN_CONNECTIVITY_ALGO::Build(), CONNECTIVITY_DATA::Build(), PLUGIN_CONTENT_MANAGER::DownloadToStream(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), CADSTAR_ARCHIVE_PARSER::LoadArchiveFile(), UPDATE_MANAGER::PostRequest(), and CONNECTION_GRAPH::Recalculate().
|
pure virtual |
Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).
Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
|
pure virtual |
Set the number of phases.
Implemented in BACKGROUND_JOB_REPORTER, CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.
|
pure virtual |
Change the title displayed on the window caption.
Has meaning only for some reporters. Does nothing for others.
Implemented in BACKGROUND_JOB_REPORTER, CLI_PROGRESS_REPORTER, PROGRESS_REPORTER_BASE, and WX_PROGRESS_REPORTER.
Referenced by PLUGIN_CONTENT_MANAGER::fetchPackages(), and PLUGIN_CONTENT_MANAGER::FetchRepository().