scoped_timer Class Reference

Timer designed to calculate the timings within scope. More...

#include <scoped_timer.h>

Public Member Functions
	scoped_timer (std::string master_name="", std::string secondary_name="")
	Cnstructor. More...
	scoped_timer (const credit *cr, std::string secondary_name="")
	Constructor. More...
virtual	~scoped_timer ()
	Default destructor for scoped_timer.
void	tick ()
	Start recording time.
double	tock (std::string subname="")
	Stop recording time. More...
std::string	stock (std::string subname="")
	Stop recording time and return time string. More...

Detailed Description

Timer designed to calculate the timings within scope.

Constructor & Destructor Documentation

scoped_timer() [1/2]

scoped_timer::scoped_timer	(	std::string	master_name = "",
		std::string	secondary_name = ""
	)

Cnstructor.

Parameters

[in]	master_name	Master name.
[in]	secondary_name	Secondary name.

scoped_timer() [2/2]

scoped_timer::scoped_timer	(	const credit *	cr,
		std::string	secondary_name = ""
	)

Constructor.

Parameters

[in]	cr	Poiter to an instance of credit.
[in]	secondary_name	Secondary name.

Member Function Documentation

stock()

std::string scoped_timer::stock

(

std::string

subname = ""

)

Stop recording time and return time string.

Parameters

[in]

subname

Subname.

Returns

Human readable timing information.

tock()

double scoped_timer::tock

(

std::string

subname = ""

)

Stop recording time.

Parameters

[in]

subname

Subname.

Returns

Time in milliseconds.

---

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

• include/shiokaze/core/scoped_timer.h