ompl::tools::Profiler Class Reference

This is a simple thread-safe tool for counting time spent in various chunks of code. This is different from external profiling tools in that it allows the user to count time spent in various bits of code (sub-function granularity) or count how many times certain pieces of code are executed. More...

#include <ompl/tools/debug/Profiler.h>

Classes

class  ScopedBlock
 This instance will call Profiler::begin() when constructed and Profiler::end() when it goes out of scope. More...
 
class  ScopedStart
 This instance will call Profiler::start() when constructed and Profiler::stop() when it goes out of scope. If the profiler was already started, this block's constructor and destructor take no action. More...
 

Public Member Functions

 Profiler (const Profiler &)=delete
 
Profileroperator= (const Profiler &)=delete
 
 Profiler (bool printOnDestroy=false, bool autoStart=false)
 Constructor. It is allowed to separately instantiate this class (not only as a singleton)
 
 ~Profiler ()
 Destructor.
 
void start ()
 Start counting time.
 
void stop ()
 Stop counting time.
 
void clear ()
 Clear counted time and events.
 
void event (const std::string &name, const unsigned int times=1)
 Count a specific event for a number of times.
 
void average (const std::string &name, const double value)
 Maintain the average of a specific value.
 
void begin (const std::string &name)
 Begin counting time for a specific chunk of code.
 
void end (const std::string &name)
 Stop counting time for a specific chunk of code.
 
void status (std::ostream &out=std::cout, bool merge=true)
 Print the status of the profiled code chunks and events. Optionally, computation done by different threads can be printed separately.
 
void console ()
 Print the status of the profiled code chunks and events to the console (using msg::Console)
 
bool running () const
 Check if the profiler is counting time or not.
 

Static Public Member Functions

static ProfilerInstance ()
 Return an instance of the class. More...
 
static void Start ()
 Start counting time.
 
static void Stop ()
 Stop counting time.
 
static void Clear ()
 Clear counted time and events.
 
static void Event (const std::string &name, const unsigned int times=1)
 Count a specific event for a number of times.
 
static void Average (const std::string &name, const double value)
 Maintain the average of a specific value.
 
static void Begin (const std::string &name)
 Begin counting time for a specific chunk of code.
 
static void End (const std::string &name)
 Stop counting time for a specific chunk of code.
 
static void Status (std::ostream &out=std::cout, bool merge=true)
 Print the status of the profiled code chunks and events. Optionally, computation done by different threads can be printed separately.
 
static void Console ()
 Print the status of the profiled code chunks and events to the console (using msg::Console)
 
static bool Running ()
 Check if the profiler is counting time or not.
 

Detailed Description

This is a simple thread-safe tool for counting time spent in various chunks of code. This is different from external profiling tools in that it allows the user to count time spent in various bits of code (sub-function granularity) or count how many times certain pieces of code are executed.

Definition at line 72 of file Profiler.h.

Member Function Documentation

◆ Instance()

ompl::tools::Profiler & ompl::tools::Profiler::Instance ( )
static

Return an instance of the class.

Author
Ioan Sucan

Definition at line 40 of file Profiler.cpp.


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