Timer Class Reference

Store for 'n' records helps for organised access. More...

#include <Timer.h>

List of all members.

Public Member Functions
	Timer ()
	default ctor
void	startCycle (const std::string &_recordName)
	start a timer cycle, if record is not recognised it will be created
void	endCycle (const std::string &_recordName)
	end a timer cycle, if record is not recognised it will be created
float	peek (const std::string &_recordName)
	peek into a timer getting its currnt seconds
void	addRecord (const std::string &_name)
	add a record to the timer
void	reset (const std::string &_recordName)
	reset a record
void	writeToCSV (const std::string &_file, const std::string &_recordName)
	write a record to CSV
void	writeAllToCSV (const std::string &_file)
	write all records to CSV
std::string	getRecord (const std::string &_recordName)
	return record string report for logging
std::string	getAll ()
	get all the records by string report

---

Detailed Description

Store for 'n' records helps for organised access.

---

Constructor & Destructor Documentation

Timer::Timer

(

)

default ctor

---

Member Function Documentation

void Timer::addRecord

(

const std::string &

_name

)

add a record to the timer

Parameters:

[in]

_name

the name of the new record

void Timer::endCycle

(

const std::string &

_recordName

)

end a timer cycle, if record is not recognised it will be created

Parameters:

[in]

_recordName

the record to act on

std::string Timer::getAll

(

)

get all the records by string report

std::string Timer::getRecord

(

const std::string &

_recordName

)

return record string report for logging

Parameters:

[in]

_recordName

the record to act on

float Timer::peek

(

const std::string &

_recordName

)

[inline]

peek into a timer getting its currnt seconds

Parameters:

[in]

_recordName

the record to act on

void Timer::reset

(

const std::string &

_recordName

)

reset a record

Parameters:

[in]

_recordName

the record to act on

void Timer::startCycle

(

const std::string &

_recordName

)

start a timer cycle, if record is not recognised it will be created

Parameters:

[in]

_recordName

the record to act on

void Timer::writeAllToCSV

(

const std::string &

_file

)

write all records to CSV

Parameters:

[in]

_file

the file name

void Timer::writeToCSV	(	const std::string &	_file,
		const std::string &	_recordName
	)

write a record to CSV

Parameters:

[in]	_file	the file name
[in]	_recordName	the record to act on

---

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

• include/Timer.h
• src/Timer.cpp