audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater Class Reference

Inheritance diagram for audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater:

Collaboration diagram for audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater:

Public Member Functions
	ExportProgressUpdater (ShareAudioDialog &parent)
	~ExportProgressUpdater () override
void	Cancel ()
ExportResult	GetResult () const
void	SetResult (ExportResult result)
void	SetStatusString (const TranslatableString &str) override
bool	IsCancelled () const override
bool	IsStopped () const override
void	OnProgress (double value) override
void	UpdateUI ()
Public Member Functions inherited from ExportProcessorDelegate
virtual	~ExportProcessorDelegate ()
virtual bool	IsCancelled () const =0
virtual bool	IsStopped () const =0
virtual void	SetStatusString (const TranslatableString &str)=0
virtual void	OnProgress (double progress)=0

Private Attributes
ShareAudioDialog &	mParent
std::atomic< bool >	mCancelled {false}
std::atomic< double >	mProgress
ExportResult	mResult

Detailed Description

Definition at line 107 of file ShareAudioDialog.cpp.

Constructor & Destructor Documentation

ExportProgressUpdater()

audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::ExportProgressUpdater ( ShareAudioDialog &  parent )

inline

Definition at line 110 of file ShareAudioDialog.cpp.

      : mParent(parent)
   {
 
   }

~ExportProgressUpdater()

audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::~ExportProgressUpdater ( )

inlineoverride

Definition at line 116 of file ShareAudioDialog.cpp.

{ }

Member Function Documentation

Cancel()

void audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::Cancel ( )

inline

Definition at line 118 of file ShareAudioDialog.cpp.

   {
      mCancelled.store(true, std::memory_order_release);
   }

References mCancelled.

GetResult()

ExportResult audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::GetResult ( ) const

inline

Definition at line 123 of file ShareAudioDialog.cpp.

   {
      return mResult;
   }

References mResult.

IsCancelled()

bool audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::IsCancelled ( ) const

inlineoverridevirtual

Implements ExportProcessorDelegate.

Definition at line 137 of file ShareAudioDialog.cpp.

   {
      return mCancelled.load(std::memory_order_acquire);
   }

References mCancelled.

IsStopped()

bool audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::IsStopped ( ) const

inlineoverridevirtual

Implements ExportProcessorDelegate.

Definition at line 142 of file ShareAudioDialog.cpp.

   {
      return false;
   }

OnProgress()

void audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::OnProgress ( double  value )

inlineoverridevirtual

Implements ExportProcessorDelegate.

Definition at line 147 of file ShareAudioDialog.cpp.

   {
      mProgress.store(value, std::memory_order_release);
   }

References mProgress.

SetResult()

void audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::SetResult ( ExportResult  result )

inline

Definition at line 128 of file ShareAudioDialog.cpp.

   {
      mResult = result;
   }

References mResult.

SetStatusString()

void audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::SetStatusString ( const TranslatableString &  str )

inlineoverridevirtual

Implements ExportProcessorDelegate.

Definition at line 133 of file ShareAudioDialog.cpp.

   {
   }

UpdateUI()

void audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::UpdateUI ( )

inline

Definition at line 152 of file ShareAudioDialog.cpp.

   {
      constexpr auto ProgressSteps = 1000ull;
 
      mParent.UpdateProgress(mProgress.load(std::memory_order_acquire) * ProgressSteps, ProgressSteps);
   }

References mParent, mProgress, and audacity::cloud::audiocom::ShareAudioDialog::UpdateProgress().

Here is the call graph for this function:

Member Data Documentation

mCancelled

std::atomic<bool> audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::mCancelled {false}

private

Definition at line 163 of file ShareAudioDialog.cpp.

Referenced by Cancel(), and IsCancelled().

mParent

ShareAudioDialog& audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::mParent

private

Definition at line 161 of file ShareAudioDialog.cpp.

Referenced by UpdateUI().

mProgress

std::atomic<double> audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::mProgress

private

Definition at line 164 of file ShareAudioDialog.cpp.

Referenced by OnProgress(), and UpdateUI().

mResult

ExportResult audacity::cloud::audiocom::ShareAudioDialog::ExportProgressUpdater::mResult

private

Definition at line 165 of file ShareAudioDialog.cpp.

Referenced by GetResult(), and SetResult().

---

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

• ShareAudioDialog.cpp