gem::Chronometer Class Reference

Chronometer. More...

Inheritance diagram for gem::Chronometer:

Collaboration diagram for gem::Chronometer:

Public Member Functions
	Chronometer ()
	Def constructor.
	Chronometer (const Chronometer &chronometer)=default
	Default copy constructor.
	Chronometer (Chronometer &&chronometer)=default
	Default move constructor noexcept is deduced.
Chronometer &	operator= (const Chronometer &chronometer)=default
	Default copy assignment.
Chronometer &	operator= (Chronometer &&chronometer)=default
	Default move assignment noexcept is deduced.
Chronometer &	reset () noexcept
	Reset chronometer: stop and erase all measured intervals.
Chronometer &	start () noexcept
	Start new interval measurement.
Chronometer &	stop () noexcept
	Stop current interval measurement.
bool	isStarted () const noexcept
	Check if a measurement is started.
int	getIntervalCount () const noexcept
	Get number of measured intervals ( including the current in progress ).
double	getCurrentTime () const noexcept
	Get current measured interval time in milliseconds.
double	getTime (int interval=0) const noexcept
	Get interval time in milliseconds.
double	getTotalTime () const noexcept
	Get all intervals time.
double	getAverageTime () const noexcept
	Get average interval time.

Detailed Description

Chronometer.

Implements share-read / copy-on-write Api object over IChronometer.

Constructor & Destructor Documentation

Chronometer() [1/2]

gem::Chronometer::Chronometer ( const Chronometer & chronometer )

default

Default copy constructor.

Parameters

chronometer

The source object

Chronometer() [2/2]

gem::Chronometer::Chronometer ( Chronometer && chronometer )

default

Default move constructor noexcept is deduced.

Parameters

chronometer

The source object

Member Function Documentation

getAverageTime()

double gem::Chronometer::getAverageTime ( ) const

inlinenoexcept

Get average interval time.

Returns

The average time

getCurrentTime()

double gem::Chronometer::getCurrentTime ( ) const

inlinenoexcept

Get current measured interval time in milliseconds.

Returns

The current interval time

getIntervalCount()

int gem::Chronometer::getIntervalCount ( ) const

inlinenoexcept

Get number of measured intervals ( including the current in progress ).

Returns

The number of intervals

getTime()

double gem::Chronometer::getTime ( int interval = 0 ) const

inlinenoexcept

Get interval time in milliseconds.

Parameters

[in]

interval

The interval index

Returns

The interval time

getTotalTime()

double gem::Chronometer::getTotalTime ( ) const

inlinenoexcept

Get all intervals time.

Returns

The total time

isStarted()

bool gem::Chronometer::isStarted ( ) const

inlinenoexcept

Check if a measurement is started.

Returns

True if started, false otherwise

operator=() [1/2]

Chronometer & gem::Chronometer::operator= ( Chronometer && chronometer )

default

Default move assignment noexcept is deduced.

Parameters

chronometer

The source object

Returns

The target object

operator=() [2/2]

Chronometer & gem::Chronometer::operator= ( const Chronometer & chronometer )

default

Default copy assignment.

Parameters

chronometer

The source object

Returns

The target object

reset()

Chronometer & gem::Chronometer::reset ( )

inlinenoexcept

Reset chronometer: stop and erase all measured intervals.

Returns

The target object

start()

Chronometer & gem::Chronometer::start ( )

inlinenoexcept

Start new interval measurement.

Returns

The target object

stop()

Chronometer & gem::Chronometer::stop ( )

inlinenoexcept

Stop current interval measurement.

Returns

The target object