Timer Class Reference

Inverval timer. More...

#include <cc/Timer>

Inheritance diagram for Timer:

Public Member Functions
	Timer ()=default
	Create a null timer.
	Timer (double interval)
	Create a repeating interval timer.
Timer &	onTimeout (Function< void()> &&f)
	Register function f to be called on timeout.
Timer &	start ()
	Start timer.
Timer &	startAt (double startTime)
	Start timer at a later startTime.
Timer &	startIn (double delayTime)
	Start timer after a giving delayTime.
void	stop ()
	Stop the timer.
bool	isActive () const
	Timer is active and generates timeout signals
double	firstTime () const
	The first time the timer emits the timeout signal.
double	startTime () const
	Beginning of the first timeout interval.
double	interval () const
	Time between two timeout signal emissions
int	run ()
	Convenience method to run the application loop.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
template<class T >
bool	is () const
	Check if this object is of type T.
template<class T >
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.
long	useCount () const
	Reference count.

Additional Inherited Members
Protected Member Functions inherited from Object
template<class T >
T	weak () const
template<class T >
void	initOnce ()
	Create the object state when called the first time.
template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T >
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Inverval timer.

See also

System::now(), Date

Constructor & Destructor Documentation

Timer() [1/2]

Timer ( )

default

Create a null timer.

Timer() [2/2]

Timer ( double interval )

explicit

Create a repeating interval timer.

Parameters

interval

Interval in which the timeout signal is triggered

Member Function Documentation

onTimeout()

Timer & onTimeout

(

Function< void()> &&

f

)

Register function f to be called on timeout.

start()

Timer & start

(

)

Start timer.

startAt()

Timer & startAt

(

double

startTime

)

Start timer at a later startTime.

startIn()

Timer & startIn

(

double

delayTime

)

Start timer after a giving delayTime.

stop()

void stop

(

)

Stop the timer.

isActive()

bool isActive

(

)

const

Timer is active and generates timeout signals

firstTime()

double firstTime

(

)

const

The first time the timer emits the timeout signal.

startTime()

double startTime

(

)

const

Beginning of the first timeout interval.

interval()

double interval

(

)

const

Time between two timeout signal emissions

run()

int run

(

)

Convenience method to run the application loop.