mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
102 lines
3.5 KiB
C++
102 lines
3.5 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Portions of this file are from JUCE.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
Please visit http://www.juce.com
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_PERFORMANCECOUNTER_H_INCLUDED
|
|
#define BEAST_PERFORMANCECOUNTER_H_INCLUDED
|
|
|
|
//==============================================================================
|
|
/** A timer for measuring performance of code and dumping the results to a file.
|
|
|
|
e.g. @code
|
|
|
|
PerformanceCounter pc ("fish", 50, "/temp/myfishlog.txt");
|
|
|
|
for (;;)
|
|
{
|
|
pc.start();
|
|
|
|
doSomethingFishy();
|
|
|
|
pc.stop();
|
|
}
|
|
@endcode
|
|
|
|
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.
|
|
*/
|
|
class BEAST_API PerformanceCounter
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a PerformanceCounter object.
|
|
|
|
@param counterName the name used when printing out the statistics
|
|
@param runsPerPrintout the number of start/stop iterations before calling
|
|
printStatistics()
|
|
@param loggingFile a file to dump the results to - if this is
|
|
File::nonexistent (), the results are just written
|
|
to the debugger output
|
|
*/
|
|
PerformanceCounter (const String& counterName,
|
|
int runsPerPrintout = 100,
|
|
const File& loggingFile = File::nonexistent ());
|
|
|
|
/** Destructor. */
|
|
~PerformanceCounter();
|
|
|
|
//==============================================================================
|
|
/** Starts timing.
|
|
|
|
@see stop
|
|
*/
|
|
void start();
|
|
|
|
/** Stops timing and prints out the results.
|
|
|
|
The number of iterations before doing a printout of the
|
|
results is set in the constructor.
|
|
|
|
@see start
|
|
*/
|
|
void stop();
|
|
|
|
/** 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).
|
|
*/
|
|
void printStatistics();
|
|
|
|
private:
|
|
//==============================================================================
|
|
String name;
|
|
int numRuns, runsPerPrint;
|
|
double totalTime;
|
|
int64 started;
|
|
File outputFile;
|
|
};
|
|
|
|
#endif // BEAST_PERFORMANCECOUNTER_H_INCLUDED
|