KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | List of all members
PROGRESS_REPORTER Class Referenceabstract

A progress reporter interface for use in multi-threaded environments. More...

#include <progress_reporter.h>

Inheritance diagram for PROGRESS_REPORTER:
CLI_PROGRESS_REPORTER PROGRESS_REPORTER_BASE BACKGROUND_JOB_REPORTER CONSOLE_PROGRESS_REPORTER CONSOLE_PROGRESS_REPORTER DIALOG_DRC DIALOG_ERC DIALOG_PCM_PROGRESS GAUGE_PROGRESS_REPORTER WX_PROGRESS_REPORTER

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
 

Detailed Description

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 39 of file progress_reporter.h.

Constructor & Destructor Documentation

◆ PROGRESS_REPORTER() [1/2]

PROGRESS_REPORTER::PROGRESS_REPORTER ( )
inline

Definition at line 43 of file progress_reporter.h.

Referenced by CLI_PROGRESS_REPORTER::GetInstance(), PROGRESS_REPORTER(), and PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE().

◆ PROGRESS_REPORTER() [2/2]

PROGRESS_REPORTER::PROGRESS_REPORTER ( const PROGRESS_REPORTER & )
delete

References PROGRESS_REPORTER().

◆ ~PROGRESS_REPORTER()

virtual PROGRESS_REPORTER::~PROGRESS_REPORTER ( )
inlinevirtual

Definition at line 48 of file progress_reporter.h.

Member Function Documentation

◆ AddPhases()

virtual void PROGRESS_REPORTER::AddPhases ( int aNumPhases)
pure virtual

Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.

◆ AdvancePhase() [1/2]

virtual void PROGRESS_REPORTER::AdvancePhase ( )
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().

◆ AdvancePhase() [2/2]

virtual void PROGRESS_REPORTER::AdvancePhase ( const wxString & aMessage)
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.

◆ AdvanceProgress()

virtual void PROGRESS_REPORTER::AdvanceProgress ( )
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().

◆ BeginPhase()

virtual void PROGRESS_REPORTER::BeginPhase ( int aPhase)
pure virtual

Initialize the aPhase virtual zone of the dialog progress bar.

Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.

◆ IsCancelled()

virtual bool PROGRESS_REPORTER::IsCancelled ( ) const
pure virtual

Implemented in CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.

Referenced by CN_CONNECTIVITY_ALGO::Build(), BOARD::CacheTriangulation(), PLUGIN_CONTENT_MANAGER::DownloadToStream(), UPDATE_MANAGER::PostRequest(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), and DRC_TOOL::RunTests().

◆ KeepRefreshing()

virtual bool PROGRESS_REPORTER::KeepRefreshing ( bool aWait = false)
pure virtual

Update the UI (if any).

Warning
This should only be called from the main thread.
Returns
false if the user cancelled.

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(), and CONNECTION_GRAPH::Recalculate().

◆ Report()

virtual void PROGRESS_REPORTER::Report ( const wxString & aMessage)
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().

◆ SetCurrentProgress()

virtual void PROGRESS_REPORTER::SetCurrentProgress ( double aProgress)
pure virtual

Set the progress value to aProgress (0..1).

Implemented in BACKGROUND_JOB_REPORTER, 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().

◆ SetMaxProgress()

virtual void PROGRESS_REPORTER::SetMaxProgress ( int aMaxProgress)
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.

◆ SetNumPhases()

virtual void PROGRESS_REPORTER::SetNumPhases ( int aNumPhases)
pure virtual

Set the number of phases.

Implemented in BACKGROUND_JOB_REPORTER, CLI_PROGRESS_REPORTER, and PROGRESS_REPORTER_BASE.

◆ SetTitle()

virtual void PROGRESS_REPORTER::SetTitle ( const wxString & aTitle)
pure virtual

Change the title displayed on the window caption.

Has meaning only for some reporters. Does nothing for others.

Warning
This should only be called from the main thread.

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().

The documentation for this class was generated from the following file: