Multi-thread safe progress reporter dialog, intended for use of tasks that paralleize reporting back of work status See PROGRESS_REPORTER. More...

#include <progress_reporter.h>

Inheritance diagram for WX_PROGRESS_REPORTER:

Public Member Functions
	WX_PROGRESS_REPORTER (wxWindow *aParent, const wxString &aTitle, int aNumPhases, bool aCanAbort=true, bool aReserveSpaceForMessage=true)
	Ctor: the PROGRESS_REPORTER will stay on top of aParent. More...

	~WX_PROGRESS_REPORTER ()

virtual void	SetTitle (const wxString &aTitle) override
	change the title displayed on the window caption More...

void	SetNumPhases (int aNumPhases)
	sets the number of phases More...

void	AddPhases (int aNumPhases)

virtual void	BeginPhase (int aPhase)
	initialize the aPhase virtual zone of the dialog progress bar More...

virtual void	AdvancePhase ()
	Uses the next vailable virtual zone of the dialog progress bar. More...

virtual void	AdvancePhase (const wxString &aMessage)
	Uses the next vailable virtual zone of the dialog progress bar and updates the message. More...

virtual void	Report (const wxString &aMessage)
	Display aMessage in the progress bar dialog. More...

virtual void	SetCurrentProgress (double aProgress)
	Set the progress value to aProgress (0..1) More...

void	SetMaxProgress (int aMaxProgress)
	Fix the value thar gives the 100 precent progress bar length (inside the current virtual zone) More...

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

bool	KeepRefreshing (bool aWait=false)
	Update the UI dialog. More...

bool	IsCancelled () const

Protected Member Functions
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

Private Member Functions
virtual bool	updateUI () override

Detailed Description

Multi-thread safe progress reporter dialog, intended for use of tasks that paralleize reporting back of work status See PROGRESS_REPORTER.

Definition at line 131 of file progress_reporter.h.

Constructor & Destructor Documentation

◆ WX_PROGRESS_REPORTER()

WX_PROGRESS_REPORTER::WX_PROGRESS_REPORTER	(	wxWindow *	aParent,
		const wxString &	aTitle,
		int	aNumPhases,
		bool	aCanAbort = `true`,
		bool	aReserveSpaceForMessage = `true`
	)

Ctor: the PROGRESS_REPORTER will stay on top of aParent.

the style is wxPD_AUTO_HIDE | wxPD_CAN_ABORT | wxPD_ELAPSED_TIME

Parameters

aParent	is the wxDialog of Frame that manage this.
aTitle	is the dialog progress title
aNumPhases	is the number of "virtual sections" of the progress bar aNumPhases = 1 is the usual progress bar aNumPhases = n creates n virtual progress bar zones: a 0 to 100 percent width of a virtual zone fills 0 to 1/n progress bar full size of the nth virtual zone index
aCanAbort	is true if the abort button should be shown
aReserveSpaceForMessage	will ensure that the dialog is laid out for status messages, preventing layout issues on Windows when reporting a message after the initial layout

Definition at line 135 of file progress_reporter.cpp.

                                                                            :
     PROGRESS_REPORTER( aNumPhases ),
     wxProgressDialog( aTitle, ( aReserveSpaceForMessage ? wxT( " " ) : wxT( "" ) ), 1, aParent,
                       // wxPD_APP_MODAL |   // Don't use; messes up OSX when called from
                                             // quasi-modal dialog
                       wxPD_AUTO_HIDE |      // *MUST* use; otherwise wxWidgets will spin
                                             // up another event loop on completion which
                                             // causes all sorts of grief
                       ( aCanAbort ? wxPD_CAN_ABORT : 0 ) |
                       wxPD_ELAPSED_TIME )
 #if wxCHECK_VERSION( 3, 1, 0 )
     ,
     m_appProgressIndicator( aParent )
 #endif
 {
 #if wxCHECK_VERSION( 3, 1, 0 )
     // wxAppProgressIndicator doesn't like value > max, ever. However there are some risks
     // with multithreaded setting of those values making a mess
     // the cop out is just to set the progress to "indeterminate"
     m_appProgressIndicator.Pulse();
 #endif
 }

◆ ~WX_PROGRESS_REPORTER()

WX_PROGRESS_REPORTER::~WX_PROGRESS_REPORTER ( )

Definition at line 161 of file progress_reporter.cpp.

162 {

163 }

Member Function Documentation

◆ AddPhases()

void PROGRESS_REPORTER::AddPhases ( int aNumPhases )

inherited

Definition at line 91 of file progress_reporter.cpp.

 {
     m_numPhases += aNumPhases;
 }

References PROGRESS_REPORTER::m_numPhases.

◆ AdvancePhase() [1/2]

void PROGRESS_REPORTER::AdvancePhase ( )

virtualinherited

Uses the next vailable virtual zone of the dialog progress bar.

Definition at line 46 of file progress_reporter.cpp.

 {
     m_phase.fetch_add( 1 );
     m_progress.store( 0 );
 }

References PROGRESS_REPORTER::m_phase, and PROGRESS_REPORTER::m_progress.

Referenced by DIALOG_ERC::AdvancePhase(), PROGRESS_REPORTER::AdvancePhase(), DIALOG_DRC::AdvancePhase(), ZONE_FILLER::Fill(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), DRC_ENGINE::ReportPhase(), DRC_TOOL::RunTests(), DIALOG_ERC::testErc(), and SYMBOL_ASYNC_LOADER::worker().

◆ AdvancePhase() [2/2]

void PROGRESS_REPORTER::AdvancePhase ( const wxString & aMessage )

virtualinherited

Uses the next vailable virtual zone of the dialog progress bar and updates the message.

Reimplemented in DIALOG_DRC, and DIALOG_ERC.

Definition at line 53 of file progress_reporter.cpp.

 {
     AdvancePhase();
     Report( aMessage );
 }

References PROGRESS_REPORTER::AdvancePhase(), and PROGRESS_REPORTER::Report().

◆ AdvanceProgress()

void PROGRESS_REPORTER::AdvanceProgress ( )

inherited

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

Definition at line 79 of file progress_reporter.cpp.

 {
     m_progress.fetch_add( 1 );
 }

References PROGRESS_REPORTER::m_progress.

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), ZONE_FILLER::Fill(), FOOTPRINT_LIST_IMPL::joinWorkers(), and FOOTPRINT_LIST_IMPL::loader_job().

◆ BeginPhase()

void PROGRESS_REPORTER::BeginPhase ( int aPhase )

virtualinherited

initialize the aPhase virtual zone of the dialog progress bar

Definition at line 39 of file progress_reporter.cpp.

 {
     m_phase.store( aPhase );
     m_progress.store( 0 );
 }

References PROGRESS_REPORTER::m_phase, and PROGRESS_REPORTER::m_progress.

◆ currentProgress()

int PROGRESS_REPORTER::currentProgress ( ) const

protectedinherited

Definition at line 97 of file progress_reporter.cpp.

 {
     double current = ( 1.0 / (double) m_numPhases ) *
                      ( (double) m_phase + ( (double) m_progress.load() / (double) m_maxProgress ) );
 
     return (int)( current * 1000 );
 }

References PROGRESS_REPORTER::m_maxProgress, PROGRESS_REPORTER::m_numPhases, PROGRESS_REPORTER::m_phase, and PROGRESS_REPORTER::m_progress.

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

◆ IsCancelled()

bool PROGRESS_REPORTER::IsCancelled ( ) const

inlineinherited

Definition at line 110 of file progress_reporter.h.

110 { return m_cancelled.load(); }

PROGRESS_REPORTER::m_cancelled

std::atomic_bool m_cancelled

Definition: progress_reporter.h:124

References PROGRESS_REPORTER::m_cancelled.

Referenced by ZONE_FILLER::computeRawFilledArea(), ZONE_FILLER::Fill(), ZONE_FILLER::fillSingleZone(), SYMBOL_LIBRARY_MANAGER::Preload(), and CN_CONNECTIVITY_ALGO::SearchClusters().

◆ KeepRefreshing()

bool PROGRESS_REPORTER::KeepRefreshing ( bool aWait = false )

inherited

Update the UI dialog.

MUST only be called from the main thread. Returns false if the user clicked Cancel.

Definition at line 106 of file progress_reporter.cpp.

 {
     if( aWait )
     {
         while( m_progress.load() < m_maxProgress && m_maxProgress > 0 )
         {
             if( !updateUI() )
             {
                 m_cancelled.store( true );
                 return false;
             }
 
             wxMilliSleep( 20 );
         }
         return true;
     }
     else
     {
         if( !updateUI() )
         {
             m_cancelled.store( true );
             return false;
         }
 
         return true;
     }
 }

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

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), ZONE_FILLER::Fill(), FOOTPRINT_LIST_IMPL::joinWorkers(), SYMBOL_LIBRARY_MANAGER::Preload(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), DRC_ENGINE::ReportPhase(), DRC_ENGINE::ReportProgress(), reportProgress(), and CN_CONNECTIVITY_ALGO::searchConnections().

◆ Report()

void PROGRESS_REPORTER::Report ( const wxString & aMessage )

virtualinherited

Display aMessage in the progress bar dialog.

Reimplemented in DIALOG_ERC.

Definition at line 60 of file progress_reporter.cpp.

 {
     std::lock_guard<std::mutex> guard( m_mutex );
     m_rptMessage = aMessage;
 }

References PROGRESS_REPORTER::m_mutex, and PROGRESS_REPORTER::m_rptMessage.

Referenced by PROGRESS_REPORTER::AdvancePhase(), AR_AUTOPLACER::AutoplaceFootprints(), ZONE_FILLER::Fill(), and FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

◆ SetCurrentProgress()

void PROGRESS_REPORTER::SetCurrentProgress ( double aProgress )

virtualinherited

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

Reimplemented in CONSOLE_PROGRESS_REPORTER.

Definition at line 72 of file progress_reporter.cpp.

 {
     m_maxProgress.store( 1000 );
     m_progress.store( (int) (aProgress * 1000.0) );
 }

References PROGRESS_REPORTER::m_maxProgress, and PROGRESS_REPORTER::m_progress.

Referenced by DIALOG_ERC::AdvancePhase(), DIALOG_DRC::AdvancePhase(), DRC_ENGINE::ReportProgress(), reportProgress(), and CONSOLE_PROGRESS_REPORTER::SetCurrentProgress().

◆ SetMaxProgress()

void PROGRESS_REPORTER::SetMaxProgress ( int aMaxProgress )

inherited

Fix the value thar gives the 100 precent progress bar length (inside the current virtual zone)

Definition at line 67 of file progress_reporter.cpp.

 {
     m_maxProgress.store( aMaxProgress );
 }

References PROGRESS_REPORTER::m_maxProgress.

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), ZONE_FILLER::Fill(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), and CN_CONNECTIVITY_ALGO::searchConnections().

◆ SetNumPhases()

void PROGRESS_REPORTER::SetNumPhases ( int aNumPhases )

inherited

sets the number of phases

Definition at line 85 of file progress_reporter.cpp.

 {
     m_numPhases = aNumPhases;
 }

References PROGRESS_REPORTER::m_numPhases.

◆ SetTitle()

virtual void WX_PROGRESS_REPORTER::SetTitle ( const wxString & aTitle )

inlineoverridevirtual

change the title displayed on the window caption

Reimplemented from PROGRESS_REPORTER.

Definition at line 153 of file progress_reporter.h.

     {
         wxProgressDialog::SetTitle( aTitle );
     }

◆ updateUI()

bool WX_PROGRESS_REPORTER::updateUI ( )

overrideprivatevirtual

Implements PROGRESS_REPORTER.

Definition at line 166 of file progress_reporter.cpp.

 {
     int cur = currentProgress();
 
     if( cur < 0 || cur > 1000 )
         cur = 0;
 
     wxString message;
     {
         std::lock_guard<std::mutex> guard( m_mutex );
         message = m_rptMessage;
     }
 
     SetRange( 1000 );
     return wxProgressDialog::Update( cur, message );
 }

References PROGRESS_REPORTER::currentProgress(), PROGRESS_REPORTER::m_mutex, and PROGRESS_REPORTER::m_rptMessage.

Member Data Documentation

◆ m_cancelled

std::atomic_bool PROGRESS_REPORTER::m_cancelled

protectedinherited

Definition at line 124 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::IsCancelled(), PROGRESS_REPORTER::KeepRefreshing(), DIALOG_ERC::OnCancelClick(), DIALOG_ERC::OnRunERCClick(), and DIALOG_ERC::updateUI().

◆ m_maxProgress

std::atomic_int PROGRESS_REPORTER::m_maxProgress

protectedinherited

Definition at line 123 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::currentProgress(), PROGRESS_REPORTER::KeepRefreshing(), PROGRESS_REPORTER::SetCurrentProgress(), PROGRESS_REPORTER::SetMaxProgress(), DIALOG_DRC::updateUI(), and CONSOLE_PROGRESS_REPORTER::updateUI().

◆ m_mutex

std::mutex PROGRESS_REPORTER::m_mutex

mutableprotectedinherited

Definition at line 119 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::Report(), and updateUI().

◆ m_numPhases

std::atomic_int PROGRESS_REPORTER::m_numPhases

protectedinherited

Definition at line 121 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::AddPhases(), PROGRESS_REPORTER::currentProgress(), and PROGRESS_REPORTER::SetNumPhases().

◆ m_phase

std::atomic_int PROGRESS_REPORTER::m_phase

protectedinherited

Definition at line 120 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::BeginPhase(), and PROGRESS_REPORTER::currentProgress().

◆ m_progress

std::atomic_int PROGRESS_REPORTER::m_progress

protectedinherited

Definition at line 122 of file progress_reporter.h.

Referenced by PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::AdvanceProgress(), PROGRESS_REPORTER::BeginPhase(), PROGRESS_REPORTER::currentProgress(), PROGRESS_REPORTER::KeepRefreshing(), PROGRESS_REPORTER::SetCurrentProgress(), DIALOG_DRC::updateUI(), and CONSOLE_PROGRESS_REPORTER::updateUI().

◆ m_rptMessage

wxString PROGRESS_REPORTER::m_rptMessage

protectedinherited

Definition at line 118 of file progress_reporter.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WX_PROGRESS_REPORTER()

◆ ~WX_PROGRESS_REPORTER()

Member Function Documentation

◆ AddPhases()

◆ AdvancePhase() [1/2]

◆ AdvancePhase() [2/2]

◆ AdvanceProgress()

◆ BeginPhase()

◆ currentProgress()

◆ IsCancelled()

◆ KeepRefreshing()

◆ Report()

◆ SetCurrentProgress()

◆ SetMaxProgress()

◆ SetNumPhases()

◆ SetTitle()

◆ updateUI()

Member Data Documentation

◆ m_cancelled

◆ m_maxProgress

◆ m_mutex

◆ m_numPhases

◆ m_phase

◆ m_progress

◆ m_rptMessage