krotos::ProgressTracker Class Reference

ProgressTracker - a class to help with display of a progresas bar during audio analysis. More...

#include <KrotosAudioBufferDSP.h>

Public Member Functions
String &	getMessage ()
float	getFilledIndicator ()
float	getIndicator ()
void	setNumStages (int numStages)
void	stage (String message)
void	end (String finalMessage)
bool	isLoading ()

Private Attributes
int	m_numStages {0}
int	m_currentStage {0}
volatile bool	m_isLoading {false}
volatile float	m_indicator = 0.f
float	m_increment = 0.f
float	m_proportionUsage = 0.f
String	m_message {"---"}

Detailed Description

ProgressTracker - a class to help with display of a progresas bar during audio analysis.

Member Function Documentation

end()

void krotos::ProgressTracker::end ( String finalMessage )

inline

getFilledIndicator()

float krotos::ProgressTracker::getFilledIndicator ( )

inline

getIndicator()

float krotos::ProgressTracker::getIndicator ( )

inline

getMessage()

String & krotos::ProgressTracker::getMessage ( )

inline

isLoading()

bool krotos::ProgressTracker::isLoading ( )

inline

setNumStages()

void krotos::ProgressTracker::setNumStages ( int numStages )

inline

stage()

void krotos::ProgressTracker::stage ( String message )

inline

Member Data Documentation

m_currentStage

int krotos::ProgressTracker::m_currentStage {0}

private

m_increment

float krotos::ProgressTracker::m_increment = 0.f

private

m_indicator

volatile float krotos::ProgressTracker::m_indicator = 0.f

private

m_isLoading

volatile bool krotos::ProgressTracker::m_isLoading {false}

private

m_message

String krotos::ProgressTracker::m_message {"---"}

private

m_numStages

int krotos::ProgressTracker::m_numStages {0}

private

m_proportionUsage

float krotos::ProgressTracker::m_proportionUsage = 0.f

private

---

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

• krotos_dsp/utilities/audio_buffer/KrotosAudioBufferDSP.h