#include <profiler.h>
Classes | |
struct | AvgInfo |
Information maintained about averaged values. More... | |
struct | PerThread |
Information to be maintained for each thread. More... | |
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... | |
struct | TimeInfo |
Information about time spent in a section of the code. More... | |
Public Member Functions | |
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 | clear (void) |
Clear counted time and events. | |
void | console (void) |
Print the status of the profiled code chunks and events to the console (using msg::Console) | |
void | end (const std::string &name) |
Stop counting time for a specific chunk of code. | |
void | event (const std::string &name, const unsigned int times=1) |
Count a specific event for a number of times. | |
Profiler (bool printOnDestroy=false, bool autoStart=false) | |
Constructor. It is allowed to separately instantiate this class (not only as a singleton) | |
bool | running (void) const |
Check if the profiler is counting time or not. | |
void | start (void) |
Start counting time. | |
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 | stop (void) |
Stop counting time. | |
~Profiler (void) | |
Destructor. | |
Static Public Member Functions | |
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 | Clear (void) |
Clear counted time and events. | |
static void | Console (void) |
Print the status of the profiled code chunks and events to the console (using msg::Console) | |
static void | End (const std::string &name) |
Stop counting time for a specific chunk of code. | |
static void | Event (const std::string &name, const unsigned int times=1) |
Count a specific event for a number of times. | |
static Profiler & | Instance (void) |
Return an instance of the class. | |
static bool | Running (void) |
Check if the profiler is counting time or not. | |
static void | Start (void) |
Start counting time. | |
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 | Stop (void) |
Stop counting time. | |
Private Member Functions | |
void | printThreadInfo (std::ostream &out, const PerThread &data) |
Private Attributes | |
std::map< boost::thread::id, PerThread > | data_ |
boost::mutex | lock_ |
bool | printOnDestroy_ |
bool | running_ |
TimeInfo | tinfo_ |
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 75 of file profiler.h.
moveit::tools::Profiler::Profiler | ( | bool | printOnDestroy = false , |
bool | autoStart = false |
||
) | [inline] |
Constructor. It is allowed to separately instantiate this class (not only as a singleton)
Definition at line 130 of file profiler.h.
moveit::tools::Profiler::~Profiler | ( | void | ) | [inline] |
Destructor.
Definition at line 137 of file profiler.h.
static void moveit::tools::Profiler::Average | ( | const std::string & | name, |
const double | value | ||
) | [inline, static] |
Maintain the average of a specific value.
Definition at line 180 of file profiler.h.
void moveit::tools::Profiler::average | ( | const std::string & | name, |
const double | value | ||
) |
Maintain the average of a specific value.
static void moveit::tools::Profiler::Begin | ( | const std::string & | name | ) | [inline, static] |
Begin counting time for a specific chunk of code.
Definition at line 189 of file profiler.h.
void moveit::tools::Profiler::begin | ( | const std::string & | name | ) |
Begin counting time for a specific chunk of code.
static void moveit::tools::Profiler::Clear | ( | void | ) | [inline, static] |
Clear counted time and events.
Definition at line 156 of file profiler.h.
void moveit::tools::Profiler::clear | ( | void | ) |
Clear counted time and events.
static void moveit::tools::Profiler::Console | ( | void | ) | [inline, static] |
Print the status of the profiled code chunks and events to the console (using msg::Console)
Definition at line 221 of file profiler.h.
void moveit::tools::Profiler::console | ( | void | ) |
Print the status of the profiled code chunks and events to the console (using msg::Console)
static void moveit::tools::Profiler::End | ( | const std::string & | name | ) | [inline, static] |
Stop counting time for a specific chunk of code.
Definition at line 195 of file profiler.h.
void moveit::tools::Profiler::end | ( | const std::string & | name | ) |
Stop counting time for a specific chunk of code.
static void moveit::tools::Profiler::Event | ( | const std::string & | name, |
const unsigned int | times = 1 |
||
) | [inline, static] |
Count a specific event for a number of times.
Definition at line 171 of file profiler.h.
void moveit::tools::Profiler::event | ( | const std::string & | name, |
const unsigned int | times = 1 |
||
) |
Count a specific event for a number of times.
moveit::tools::Profiler & moveit::tools::Profiler::Instance | ( | void | ) | [static] |
Return an instance of the class.
Definition at line 39 of file profiler.cpp.
void moveit::tools::Profiler::printThreadInfo | ( | std::ostream & | out, |
const PerThread & | data | ||
) | [private] |
bool moveit::tools::Profiler::running | ( | void | ) | const [inline] |
Check if the profiler is counting time or not.
Definition at line 231 of file profiler.h.
static bool moveit::tools::Profiler::Running | ( | void | ) | [inline, static] |
Check if the profiler is counting time or not.
Definition at line 237 of file profiler.h.
static void moveit::tools::Profiler::Start | ( | void | ) | [inline, static] |
Start counting time.
Definition at line 144 of file profiler.h.
void moveit::tools::Profiler::start | ( | void | ) |
Start counting time.
static void moveit::tools::Profiler::Status | ( | std::ostream & | out = std::cout , |
bool | merge = true |
||
) | [inline, static] |
Print the status of the profiled code chunks and events. Optionally, computation done by different threads can be printed separately.
Definition at line 209 of file profiler.h.
void moveit::tools::Profiler::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 moveit::tools::Profiler::Stop | ( | void | ) | [inline, static] |
Stop counting time.
Definition at line 150 of file profiler.h.
void moveit::tools::Profiler::stop | ( | void | ) |
Stop counting time.
std::map<boost::thread::id, PerThread> moveit::tools::Profiler::data_ [private] |
Definition at line 314 of file profiler.h.
boost::mutex moveit::tools::Profiler::lock_ [private] |
Definition at line 313 of file profiler.h.
bool moveit::tools::Profiler::printOnDestroy_ [private] |
Definition at line 317 of file profiler.h.
bool moveit::tools::Profiler::running_ [private] |
Definition at line 316 of file profiler.h.
TimeInfo moveit::tools::Profiler::tinfo_ [private] |
Definition at line 315 of file profiler.h.