A timer for measuring performance of code and dumping the results to a file. More...

Classes
struct	Statistics
	Holds the current statistics. More...

Public Member Functions
	PerformanceCounter (const String &counterName, int runsPerPrintout=100, const File &loggingFile=File())
	Creates a PerformanceCounter object. More...

	~PerformanceCounter ()
	Destructor. More...

void	start () noexcept
	Starts timing. More...

bool	stop ()
	Stops timing and prints out the results. More...

void	printStatistics ()
	Dumps the current metrics to the debugger output and to a file. More...

Statistics	getStatisticsAndReset ()
	Returns a copy of the current stats, and resets the internal counter. More...

Detailed Description

A timer for measuring performance of code and dumping the results to a file.

e.g.

PerformanceCounter pc ("fish", 50, "/temp/myfishlog.txt");
for (;;)
{
    pc.start();
    doSomethingFishy();
    pc.stop();
}

In this example, the time of each period between calling start/stop will be measured and averaged over 50 runs, and the results printed to a file every 50 times round the loop.

Constructor & Destructor Documentation

◆ PerformanceCounter()

PerformanceCounter::PerformanceCounter	(	const String &	counterName,
		int	runsPerPrintout = `100`,
		const File &	loggingFile = `File()`
	)

Creates a PerformanceCounter object.

Parameters

counterName	the name used when printing out the statistics
runsPerPrintout	the number of start/stop iterations before calling printStatistics()
loggingFile	a file to dump the results to - if this is File(), the results are just written to the debugger output

◆ ~PerformanceCounter()

PerformanceCounter::~PerformanceCounter ( )

Destructor.

Member Function Documentation

◆ start()

void PerformanceCounter::start ( )

noexcept

Starts timing.

See also: stop

◆ stop()

bool PerformanceCounter::stop ( )

Stops timing and prints out the results.

The number of iterations before doing a printout of the results is set in the constructor.

See also: start

◆ printStatistics()

void PerformanceCounter::printStatistics ( )

Dumps the current metrics to the debugger output and to a file.

As well as using Logger::outputDebugString to print the results, this will write then to the file specified in the constructor (if this was valid).

◆ getStatisticsAndReset()

Statistics PerformanceCounter::getStatisticsAndReset ( )

Returns a copy of the current stats, and resets the internal counter.

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

juce_PerformanceCounter.h

Classes

Public Member Functions