KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
BACKGROUND_JOB_REPORTER Class Reference

#include <background_jobs_monitor.h>

Inheritance diagram for BACKGROUND_JOB_REPORTER:
PROGRESS_REPORTER_BASE PROGRESS_REPORTER

Public Member Functions

 BACKGROUND_JOB_REPORTER (BACKGROUND_JOBS_MONITOR *aMonitor, const std::shared_ptr< BACKGROUND_JOB > &aJob)
 
void SetTitle (const wxString &aTitle) override
 Change the title displayed on the window caption.
 
void Report (const wxString &aMessage) override
 Display aMessage in the progress bar dialog.
 
void Cancel ()
 
void AdvancePhase () override
 Use the next available virtual zone of the dialog progress bar.
 
void SetNumPhases (int aNumPhases) override
 Set the number of phases.
 
void SetCurrentProgress (double aProgress) override
 Set the progress value to aProgress (0..1).
 
void AddPhases (int aNumPhases) override
 
virtual void BeginPhase (int aPhase) override
 Initialize the aPhase virtual zone of the dialog progress bar.
 
virtual void AdvancePhase (const wxString &aMessage) override
 Use the next available virtual zone of the dialog progress bar and updates the message.
 
void SetMaxProgress (int aMaxProgress) override
 Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).
 
void AdvanceProgress () override
 Increment the progress bar length (inside the current virtual zone).
 
bool KeepRefreshing (bool aWait=false) override
 Update the UI dialog.
 
bool IsCancelled () const override
 
int CurrentProgress () const
 

Protected Attributes

wxString m_rptMessage
 
std::mutex m_mutex
 
std::atomic_int m_phase
 
std::atomic_int m_numPhases
 
std::atomic_int m_progress
 
std::atomic_int m_maxProgress
 
std::atomic_bool m_cancelled
 
std::atomic_bool m_messageChanged
 

Private Member Functions

bool updateUI () override
 

Private Attributes

BACKGROUND_JOBS_MONITOR * m_monitor
 
std::shared_ptr< BACKGROUND_JOB > m_job
 
wxString m_title
 
wxString m_report
 

Detailed Description

Definition at line 45 of file background_jobs_monitor.h.

Constructor & Destructor Documentation

◆ BACKGROUND_JOB_REPORTER()

BACKGROUND_JOB_REPORTER::BACKGROUND_JOB_REPORTER ( BACKGROUND_JOBS_MONITOR * aMonitor,
const std::shared_ptr< BACKGROUND_JOB > & aJob )

Definition at line 175 of file background_jobs_monitor.cpp.

References m_job, m_monitor, and PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE().

Member Function Documentation

◆ AddPhases()

void PROGRESS_REPORTER_BASE::AddPhases ( int aNumPhases)
overridevirtualinherited

Implements PROGRESS_REPORTER.

Definition at line 98 of file progress_reporter_base.cpp.

References m_numPhases.

◆ AdvancePhase() [1/2]

void BACKGROUND_JOB_REPORTER::AdvancePhase ( )
overridevirtual

Use the next available virtual zone of the dialog progress bar.

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 206 of file background_jobs_monitor.cpp.

References PROGRESS_REPORTER_BASE::AdvancePhase(), m_job, m_monitor, and PROGRESS_REPORTER_BASE::m_phase.

◆ AdvancePhase() [2/2]

void PROGRESS_REPORTER_BASE::AdvancePhase ( const wxString & aMessage)
overridevirtualinherited

Use the next available virtual zone of the dialog progress bar and updates the message.

Implements PROGRESS_REPORTER.

Reimplemented in DIALOG_DRC, and DIALOG_ERC.

Definition at line 57 of file progress_reporter_base.cpp.

References AdvancePhase(), and Report().

◆ AdvanceProgress()

void PROGRESS_REPORTER_BASE::AdvanceProgress ( )
overridevirtualinherited

Increment the progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 86 of file progress_reporter_base.cpp.

References m_progress.

◆ BeginPhase()

void PROGRESS_REPORTER_BASE::BeginPhase ( int aPhase)
overridevirtualinherited

Initialize the aPhase virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Definition at line 43 of file progress_reporter_base.cpp.

References m_phase, and m_progress.

◆ Cancel()

void BACKGROUND_JOB_REPORTER::Cancel ( )
inline

Definition at line 57 of file background_jobs_monitor.h.

References PROGRESS_REPORTER_BASE::m_cancelled.

◆ CurrentProgress()

int PROGRESS_REPORTER_BASE::CurrentProgress ( ) const
inherited

Definition at line 104 of file progress_reporter_base.cpp.

References m_maxProgress, m_numPhases, m_phase, and m_progress.

Referenced by GAUGE_PROGRESS_REPORTER::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ IsCancelled()

bool PROGRESS_REPORTER_BASE::IsCancelled ( ) const
inlineoverridevirtualinherited

Implements PROGRESS_REPORTER.

Definition at line 108 of file progress_reporter_base.h.

References m_cancelled.

◆ KeepRefreshing()

bool PROGRESS_REPORTER_BASE::KeepRefreshing ( bool aWait = false)
overridevirtualinherited

Update the UI dialog.

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

Implements PROGRESS_REPORTER.

Definition at line 113 of file progress_reporter_base.cpp.

References m_cancelled, m_maxProgress, m_progress, and updateUI().

Referenced by SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ Report()

void BACKGROUND_JOB_REPORTER::Report ( const wxString & aMessage)
overridevirtual

Display aMessage in the progress bar dialog.

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 191 of file background_jobs_monitor.cpp.

References m_job, and m_monitor.

◆ SetCurrentProgress()

void BACKGROUND_JOB_REPORTER::SetCurrentProgress ( double aProgress)
overridevirtual

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

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 214 of file background_jobs_monitor.cpp.

References m_job, m_monitor, and PROGRESS_REPORTER_BASE::SetCurrentProgress().

◆ SetMaxProgress()

void PROGRESS_REPORTER_BASE::SetMaxProgress ( int aMaxProgress)
overridevirtualinherited

Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 73 of file progress_reporter_base.cpp.

References m_maxProgress.

◆ SetNumPhases()

void BACKGROUND_JOB_REPORTER::SetNumPhases ( int aNumPhases)
overridevirtual

Set the number of phases.

Implements PROGRESS_REPORTER.

Definition at line 198 of file background_jobs_monitor.cpp.

References m_job, m_monitor, PROGRESS_REPORTER_BASE::m_numPhases, and PROGRESS_REPORTER_BASE::SetNumPhases().

◆ SetTitle()

void BACKGROUND_JOB_REPORTER::SetTitle ( const wxString & aTitle)
inlineoverridevirtual

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.

Implements PROGRESS_REPORTER.

Definition at line 51 of file background_jobs_monitor.h.

◆ updateUI()

bool BACKGROUND_JOB_REPORTER::updateUI ( )
overrideprivatevirtual

Implements PROGRESS_REPORTER_BASE.

Definition at line 185 of file background_jobs_monitor.cpp.

References PROGRESS_REPORTER_BASE::m_cancelled.

Member Data Documentation

◆ m_cancelled

std::atomic_bool PROGRESS_REPORTER_BASE::m_cancelled
protectedinherited

Definition at line 123 of file progress_reporter_base.h.

Referenced by BACKGROUND_JOB_REPORTER::Cancel(), IsCancelled(), KeepRefreshing(), DIALOG_DRC::OnCancelClick(), DIALOG_ERC::OnCancelClick(), DIALOG_PCM_PROGRESS::OnCancelClicked(), DIALOG_DRC::OnRunDRCClick(), DIALOG_ERC::OnRunERCClick(), PROGRESS_REPORTER_BASE(), BACKGROUND_JOB_REPORTER::updateUI(), DIALOG_DRC::updateUI(), and DIALOG_ERC::updateUI().

◆ m_job

std::shared_ptr<BACKGROUND_JOB> BACKGROUND_JOB_REPORTER::m_job
private

Definition at line 69 of file background_jobs_monitor.h.

Referenced by AdvancePhase(), BACKGROUND_JOB_REPORTER(), Report(), SetCurrentProgress(), and SetNumPhases().

◆ m_maxProgress

std::atomic_int PROGRESS_REPORTER_BASE::m_maxProgress
protectedinherited

Definition at line 122 of file progress_reporter_base.h.

Referenced by CurrentProgress(), KeepRefreshing(), DIALOG_PCM_PROGRESS::OnCloseClicked(), PROGRESS_REPORTER_BASE(), SetCurrentProgress(), SetMaxProgress(), CONSOLE_PROGRESS_REPORTER::updateUI(), and DIALOG_DRC::updateUI().

◆ m_messageChanged

std::atomic_bool PROGRESS_REPORTER_BASE::m_messageChanged
protectedinherited

Definition at line 129 of file progress_reporter_base.h.

Referenced by PROGRESS_REPORTER_BASE(), Report(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_monitor

BACKGROUND_JOBS_MONITOR* BACKGROUND_JOB_REPORTER::m_monitor
private

Definition at line 68 of file background_jobs_monitor.h.

Referenced by AdvancePhase(), BACKGROUND_JOB_REPORTER(), Report(), SetCurrentProgress(), and SetNumPhases().

◆ m_mutex

std::mutex PROGRESS_REPORTER_BASE::m_mutex
mutableprotectedinherited

Definition at line 118 of file progress_reporter_base.h.

Referenced by DIALOG_PCM_PROGRESS::PCMReport(), Report(), DIALOG_PCM_PROGRESS::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_numPhases

std::atomic_int PROGRESS_REPORTER_BASE::m_numPhases
protectedinherited

Definition at line 120 of file progress_reporter_base.h.

Referenced by AddPhases(), CurrentProgress(), PROGRESS_REPORTER_BASE(), BACKGROUND_JOB_REPORTER::SetNumPhases(), SetNumPhases(), and DIALOG_PCM_PROGRESS::updateUI().

◆ m_phase

std::atomic_int PROGRESS_REPORTER_BASE::m_phase
protectedinherited

Definition at line 119 of file progress_reporter_base.h.

Referenced by BACKGROUND_JOB_REPORTER::AdvancePhase(), AdvancePhase(), BeginPhase(), CurrentProgress(), PROGRESS_REPORTER_BASE(), and DIALOG_PCM_PROGRESS::updateUI().

◆ m_progress

std::atomic_int PROGRESS_REPORTER_BASE::m_progress
protectedinherited

Definition at line 121 of file progress_reporter_base.h.

Referenced by AdvancePhase(), AdvanceProgress(), BeginPhase(), CurrentProgress(), KeepRefreshing(), DIALOG_PCM_PROGRESS::OnCloseClicked(), PROGRESS_REPORTER_BASE(), SetCurrentProgress(), CONSOLE_PROGRESS_REPORTER::updateUI(), and DIALOG_DRC::updateUI().

◆ m_report

wxString BACKGROUND_JOB_REPORTER::m_report
private

Definition at line 71 of file background_jobs_monitor.h.

◆ m_rptMessage

wxString PROGRESS_REPORTER_BASE::m_rptMessage
protectedinherited

Definition at line 116 of file progress_reporter_base.h.

Referenced by Report(), CONSOLE_PROGRESS_REPORTER::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_title

wxString BACKGROUND_JOB_REPORTER::m_title
private

Definition at line 70 of file background_jobs_monitor.h.

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