gstlrn::Timer Class Reference

#include <Timer.hpp>

Detailed Description

Allow calculation of Timer spent in a portion of the code

Public Member Functions
	Timer ()
	Timer (const Timer &m)
Timer &	operator= (const Timer &m)
virtual	~Timer ()
void	reset ()
void	displayIntervalSeconds (const String &title="", Id expected_time=-1, bool flag_reset=true)
double	getIntervalSeconds (bool flag_reset=true)
void	displayIntervalMilliseconds (const String &title="", Id expected_time=-1, bool flag_reset=true)
double	getIntervalMilliseconds (bool flag_reset=true)

Static Public Member Functions
static void	displaySeconds (const String &title, double sec, Id expected_time=-1)
static void	displayMilliseconds (const String &title, double msec, Id expected_time=-1)

Constructor & Destructor Documentation

Timer() [1/2]

gstlrn::Timer::Timer

(

)

Timer() [2/2]

gstlrn::Timer::Timer

(

const Timer &

m

)

~Timer()

gstlrn::Timer::~Timer ( )

virtual

Member Function Documentation

displayIntervalMilliseconds()

void gstlrn::Timer::displayIntervalMilliseconds	(	const String &	title = "",
		Id	expected_time = -1,
		bool	flag_reset = true
	)

Displays the time elapsed (in ms) since the reference Timer

Parameters

title	Title used for the internal display
expected_time	Expected number of milliseconds (-1 if not used)
flag_reset	True if the Reference must be set to current Time

displayIntervalSeconds()

void gstlrn::Timer::displayIntervalSeconds	(	const String &	title = "",
		Id	expected_time = -1,
		bool	flag_reset = true
	)

Displays the time elapsed (in s) since the reference Timer

Parameters

title	Title used for the internal display
expected_time	Expected number of seconds (-1 if not used)
flag_reset	True if the Reference must be set to current Time

displayMilliseconds()

void gstlrn::Timer::displayMilliseconds ( const String &  title, double  msec, Id  expected_time = -1  )

static

displaySeconds()

void gstlrn::Timer::displaySeconds ( const String &  title, double  sec, Id  expected_time = -1  )

static

getIntervalMilliseconds()

double gstlrn::Timer::getIntervalMilliseconds

(

bool

flag_reset = true

)

getIntervalSeconds()

double gstlrn::Timer::getIntervalSeconds

(

bool

flag_reset = true

)

operator=()

Timer & gstlrn::Timer::operator=

(

const Timer &

m

)

reset()

void gstlrn::Timer::reset

(

)

Defines the reference Timer (beginning of a Timer chunk)

---

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

• include/Basic/Timer.hpp
• src/Basic/Timer.cpp