JOBS_PROGRESS_REPORTER Class Reference

#include <jobs_runner.h>

Inheritance diagram for JOBS_PROGRESS_REPORTER:

Public Member Functions
	JOBS_PROGRESS_REPORTER (wxWindow *aParent, const wxString &aTitle)
void	AdvancePhase () override
	Use the next available virtual zone of the dialog progress bar.
void	AdvanceJob (const wxString &aMessage)
void	Report (const wxString &aMessage) override
	Display aMessage in the progress bar dialog.
void	SetTitle (const wxString &aTitle) override
	Change the title displayed on the window caption.
void	SetNumPhases (int aNumPhases) override
	Set the number of phases.
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.
virtual void	SetCurrentProgress (double aProgress) override
	Set the progress value to aProgress (0..1).
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
wxString	m_jobStatus
wxAppProgressIndicator	m_appProgressIndicator
int	m_messageWidth

Detailed Description

Definition at line 33 of file jobs_runner.h.

Constructor & Destructor Documentation

JOBS_PROGRESS_REPORTER()

JOBS_PROGRESS_REPORTER::JOBS_PROGRESS_REPORTER ( wxWindow * aParent, const wxString & aTitle )

inline

Definition at line 36 of file jobs_runner.h.

References PR_NO_ABORT, and WX_PROGRESS_REPORTER::WX_PROGRESS_REPORTER().

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.

AdvanceJob()

void JOBS_PROGRESS_REPORTER::AdvanceJob ( const wxString & aMessage )

inline

Definition at line 44 of file jobs_runner.h.

References m_jobStatus, and PROGRESS_REPORTER::Report().

AdvancePhase() [1/2]

void JOBS_PROGRESS_REPORTER::AdvancePhase ( )

inlineoverridevirtual

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

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 40 of file jobs_runner.h.

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.

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.

Referenced by SYMBOL_EDIT_FRAME::SYMBOL_EDIT_FRAME().

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 JOBS_PROGRESS_REPORTER::Report ( const wxString & aMessage )

inlineoverridevirtual

Display aMessage in the progress bar dialog.

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 50 of file jobs_runner.h.

References m_jobStatus, and PROGRESS_REPORTER::Report().

SetCurrentProgress()

void PROGRESS_REPORTER_BASE::SetCurrentProgress ( double aProgress )

overridevirtualinherited

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

Implements PROGRESS_REPORTER.

Reimplemented in CONSOLE_PROGRESS_REPORTER, and CONSOLE_PROGRESS_REPORTER.

Definition at line 79 of file progress_reporter_base.cpp.

References m_maxProgress, and m_progress.

Referenced by DIALOG_DRC::AdvancePhase(), DIALOG_ERC::AdvancePhase(), and CONSOLE_PROGRESS_REPORTER::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 PROGRESS_REPORTER_BASE::SetNumPhases ( int aNumPhases )

overridevirtualinherited

Set the number of phases.

Implements PROGRESS_REPORTER.

Definition at line 92 of file progress_reporter_base.cpp.

References m_numPhases.

Referenced by DIALOG_PCM_PROGRESS::OnCancelClicked(), and BACKGROUND_JOB_REPORTER::SetNumPhases().

SetTitle()

void WX_PROGRESS_REPORTER::SetTitle ( const wxString & aTitle )

inlineoverridevirtualinherited

Change the title displayed on the window caption.

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 78 of file wx_progress_reporters.h.

updateUI()

bool WX_PROGRESS_REPORTER::updateUI ( )

overrideprivatevirtualinherited

Implements PROGRESS_REPORTER_BASE.

Definition at line 60 of file wx_progress_reporters.cpp.

References PROGRESS_REPORTER_BASE::CurrentProgress(), PROGRESS_REPORTER_BASE::m_messageChanged, m_messageWidth, PROGRESS_REPORTER_BASE::m_mutex, and PROGRESS_REPORTER_BASE::m_rptMessage.

Member Data Documentation

m_appProgressIndicator

wxAppProgressIndicator WX_PROGRESS_REPORTER::m_appProgressIndicator

privateinherited

Definition at line 87 of file wx_progress_reporters.h.

Referenced by WX_PROGRESS_REPORTER().

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_jobStatus

wxString JOBS_PROGRESS_REPORTER::m_jobStatus

private

Definition at line 56 of file jobs_runner.h.

Referenced by AdvanceJob(), and Report().

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_messageWidth

int WX_PROGRESS_REPORTER::m_messageWidth

privateinherited

Definition at line 88 of file wx_progress_reporters.h.

Referenced by updateUI(), and WX_PROGRESS_REPORTER().

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

---

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

• jobs_runner.h