coil::TimeMeasure Class Reference

TimeMeasure class. More...

#include <TimeMeasure.h>

Classes
struct	Statistics
	Structure for time statistics. More...

Public Member Functions
	TimeMeasure (int buflen=100)
	Constructor. More...
void	tick ()
	Begin time measurement for time statistics. More...
void	tack ()
	Finish time measurement for time statistics. More...
coil::TimeValue &	interval ()
	Get a interval time. More...
void	reset ()
	Initialize for statistics related data. More...
unsigned long int	count () const
	Get number of time measurement buffer. More...
bool	getStatistics (double &max_interval, double &min_interval, double &mean_interval, double &stddev)
	Get total statistics. More...
Statistics	getStatistics ()
	Get statistics result. More...

Detailed Description

TimeMeasure class.

This class is used for getting statistics of code execution time. Using get_stat you can get maximum, minimum, mean and standard deviation time for code execution.

Constructor & Destructor Documentation

coil::TimeMeasure::TimeMeasure

(

int

buflen = 100

)

Constructor.

Time Statistics object for profiling.

Member Function Documentation

unsigned long int coil::TimeMeasure::count

(

)

const

Get number of time measurement buffer.

Get number of time measurement buffer.

Returns

Measurement count

bool coil::TimeMeasure::getStatistics	(	double &	max_interval,
		double &	min_interval,
		double &	mean_interval,
		double &	stddev
	)

Get total statistics.

Get total statistics.

Parameters

max_interval	Max value [ns]
min_interval	Min value [ns]
mean_interval	Mean value [ns]
stddev	Standard deviation value

Returns

true: Data found, false: Data not found

Statistics coil::TimeMeasure::getStatistics

(

)

Get statistics result.

Get statistics result.

Returns

Statistics result

coil::TimeValue& coil::TimeMeasure::interval

(

)

Get a interval time.

Get a interval time.

Returns

TimeValue object

void coil::TimeMeasure::reset

(

)

Initialize for statistics related data.

Initialize for statistics related data.

void coil::TimeMeasure::tack

(

)

Finish time measurement for time statistics.

End of time measurement for time statistics.

void coil::TimeMeasure::tick

(

)

Begin time measurement for time statistics.

Begin time measurement for time statistics.

---

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

• /home/openrtm/doc-build/OpenRTM-aist-1.2.1/src/lib/coil/include/coil/TimeMeasure.h