KiCad PCB EDA Suite
PROGRESS_REPORTER_BASE Class Referenceabstract

This implements all the tricky bits for thread safety, but the GUI is left to derived classes. More...

#include <progress_reporter_base.h>

Inheritance diagram for PROGRESS_REPORTER_BASE:
PROGRESS_REPORTER CONSOLE_PROGRESS_REPORTER DIALOG_DRC DIALOG_ERC GAUGE_PROGRESS_REPORTER WX_PROGRESS_REPORTER

Public Member Functions

 PROGRESS_REPORTER_BASE (int aNumPhases)
 
 PROGRESS_REPORTER_BASE (const PROGRESS_REPORTER_BASE &)=delete
 
virtual ~PROGRESS_REPORTER_BASE ()
 
void SetNumPhases (int aNumPhases) override
 Set the number of phases. More...
 
void AddPhases (int aNumPhases) override
 
virtual void BeginPhase (int aPhase) override
 Initialize the aPhase virtual zone of the dialog progress bar. More...
 
virtual void AdvancePhase () override
 Use the next available virtual zone of the dialog progress bar. More...
 
virtual void AdvancePhase (const wxString &aMessage) override
 Use the next available virtual zone of the dialog progress bar and updates the message. More...
 
virtual void Report (const wxString &aMessage) override
 Display aMessage in the progress bar dialog. More...
 
virtual void SetCurrentProgress (double aProgress) override
 Set the progress value to aProgress (0..1). More...
 
void SetMaxProgress (int aMaxProgress) override
 Fix the value that gives the 100 percent progress bar length (inside the current virtual zone). More...
 
void AdvanceProgress () override
 Increment the progress bar length (inside the current virtual zone). More...
 
bool KeepRefreshing (bool aWait=false) override
 Update the UI dialog. More...
 
void SetTitle (const wxString &aTitle) override
 Change the title displayed on the window caption. More...
 
bool IsCancelled () const override
 

Protected Member Functions

int currentProgress () const
 
virtual bool updateUI ()=0
 

Protected Attributes

wxString m_rptMessage
 
bool m_msgChanged
 
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
 

Detailed Description

This implements all the tricky bits for thread safety, but the GUI is left to derived classes.

Definition at line 37 of file progress_reporter_base.h.

Constructor & Destructor Documentation

◆ PROGRESS_REPORTER_BASE() [1/2]

PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE ( int  aNumPhases)

Definition at line 31 of file progress_reporter_base.cpp.

31  :
33  m_msgChanged( false ),
34  m_phase( 0 ),
35  m_numPhases( aNumPhases ),
36  m_progress( 0 ),
37  m_maxProgress( 1000 ),
38  m_cancelled( false )
39 {
40 }

◆ PROGRESS_REPORTER_BASE() [2/2]

PROGRESS_REPORTER_BASE::PROGRESS_REPORTER_BASE ( const PROGRESS_REPORTER_BASE )
delete

◆ ~PROGRESS_REPORTER_BASE()

virtual PROGRESS_REPORTER_BASE::~PROGRESS_REPORTER_BASE ( )
inlinevirtual

Definition at line 44 of file progress_reporter_base.h.

45  {
46  }

Member Function Documentation

◆ AddPhases()

void PROGRESS_REPORTER_BASE::AddPhases ( int  aNumPhases)
overridevirtual

Implements PROGRESS_REPORTER.

Definition at line 97 of file progress_reporter_base.cpp.

98 {
99  m_numPhases += aNumPhases;
100 }

References m_numPhases.

◆ AdvancePhase() [1/2]

void PROGRESS_REPORTER_BASE::AdvancePhase ( )
overridevirtual

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

Implements PROGRESS_REPORTER.

Definition at line 50 of file progress_reporter_base.cpp.

51 {
52  m_phase.fetch_add( 1 );
53  m_progress.store( 0 );
54 }

References m_phase, and m_progress.

Referenced by DIALOG_ERC::AdvancePhase(), AdvancePhase(), DIALOG_DRC::AdvancePhase(), and DIALOG_ERC::testErc().

◆ AdvancePhase() [2/2]

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

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.

58 {
59  AdvancePhase();
60  Report( aMessage );
61 }
virtual void AdvancePhase() override
Use the next available virtual zone of the dialog progress bar.
virtual void Report(const wxString &aMessage) override
Display aMessage in the progress bar dialog.

References AdvancePhase(), and Report().

◆ AdvanceProgress()

void PROGRESS_REPORTER_BASE::AdvanceProgress ( )
overridevirtual

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

Implements PROGRESS_REPORTER.

Definition at line 85 of file progress_reporter_base.cpp.

86 {
87  m_progress.fetch_add( 1 );
88 }

References m_progress.

◆ BeginPhase()

void PROGRESS_REPORTER_BASE::BeginPhase ( int  aPhase)
overridevirtual

Initialize the aPhase virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Definition at line 43 of file progress_reporter_base.cpp.

44 {
45  m_phase.store( aPhase );
46  m_progress.store( 0 );
47 }

References m_phase, and m_progress.

◆ currentProgress()

int PROGRESS_REPORTER_BASE::currentProgress ( ) const
protected

Definition at line 103 of file progress_reporter_base.cpp.

104 {
105  double current = ( 1.0 / (double) m_numPhases ) *
106  ( (double) m_phase + ( (double) m_progress.load() / (double) m_maxProgress ) );
107 
108  return (int)( current * 1000 );
109 }

References m_maxProgress, m_numPhases, m_phase, and m_progress.

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

◆ IsCancelled()

bool PROGRESS_REPORTER_BASE::IsCancelled ( ) const
inlineoverridevirtual

Implements PROGRESS_REPORTER.

Definition at line 108 of file progress_reporter_base.h.

108 { return m_cancelled; }

References m_cancelled.

◆ KeepRefreshing()

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

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 112 of file progress_reporter_base.cpp.

113 {
114  if( aWait )
115  {
116  while( m_progress.load() < m_maxProgress && m_maxProgress > 0 )
117  {
118  if( !updateUI() )
119  {
120  m_cancelled.store( true );
121  return false;
122  }
123 
124  wxMilliSleep( 20 );
125  }
126 
127  return true;
128  }
129  else
130  {
131  if( !updateUI() )
132  {
133  m_cancelled.store( true );
134  return false;
135  }
136 
137  return true;
138  }
139 }
virtual bool updateUI()=0

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

◆ Report()

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

Display aMessage in the progress bar dialog.

Implements PROGRESS_REPORTER.

Reimplemented in DIALOG_ERC.

Definition at line 64 of file progress_reporter_base.cpp.

65 {
66  std::lock_guard<std::mutex> guard( m_mutex );
67  m_rptMessage = aMessage;
68  m_msgChanged = true;
69 }

References m_msgChanged, m_mutex, and m_rptMessage.

Referenced by AdvancePhase().

◆ SetCurrentProgress()

void PROGRESS_REPORTER_BASE::SetCurrentProgress ( double  aProgress)
overridevirtual

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

Implements PROGRESS_REPORTER.

Reimplemented in CONSOLE_PROGRESS_REPORTER.

Definition at line 78 of file progress_reporter_base.cpp.

79 {
80  m_maxProgress.store( 1000 );
81  m_progress.store( (int) ( aProgress * 1000.0 ) );
82 }

References m_maxProgress, and m_progress.

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

◆ SetMaxProgress()

void PROGRESS_REPORTER_BASE::SetMaxProgress ( int  aMaxProgress)
overridevirtual

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

Implements PROGRESS_REPORTER.

Definition at line 72 of file progress_reporter_base.cpp.

73 {
74  m_maxProgress.store( aMaxProgress );
75 }

References m_maxProgress.

◆ SetNumPhases()

void PROGRESS_REPORTER_BASE::SetNumPhases ( int  aNumPhases)
overridevirtual

Set the number of phases.

Implements PROGRESS_REPORTER.

Definition at line 91 of file progress_reporter_base.cpp.

92 {
93  m_numPhases = aNumPhases;
94 }

References m_numPhases.

◆ SetTitle()

void PROGRESS_REPORTER_BASE::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.

Reimplemented in WX_PROGRESS_REPORTER.

Definition at line 106 of file progress_reporter_base.h.

106 { }

◆ updateUI()

virtual bool PROGRESS_REPORTER_BASE::updateUI ( )
protectedpure virtual

Member Data Documentation

◆ m_cancelled

std::atomic_bool PROGRESS_REPORTER_BASE::m_cancelled
protected

◆ m_maxProgress

std::atomic_int PROGRESS_REPORTER_BASE::m_maxProgress
protected

◆ m_msgChanged

bool PROGRESS_REPORTER_BASE::m_msgChanged
protected

Definition at line 116 of file progress_reporter_base.h.

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

◆ m_mutex

std::mutex PROGRESS_REPORTER_BASE::m_mutex
mutableprotected

Definition at line 118 of file progress_reporter_base.h.

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

◆ m_numPhases

std::atomic_int PROGRESS_REPORTER_BASE::m_numPhases
protected

Definition at line 120 of file progress_reporter_base.h.

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

◆ m_phase

std::atomic_int PROGRESS_REPORTER_BASE::m_phase
protected

Definition at line 119 of file progress_reporter_base.h.

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

◆ m_progress

std::atomic_int PROGRESS_REPORTER_BASE::m_progress
protected

◆ m_rptMessage

wxString PROGRESS_REPORTER_BASE::m_rptMessage
protected

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