Inheritance diagram for PITimer:

Public Member Functions
	PITimer (TimerEvent slot=0, void *data=0, bool threaded=true)
	Constructs timer with execution function slot and common data data.

void	setData (void *data_)
	Set custom data.

void	setSlot (TimerEvent slot)
	Set timer execution function.

double	interval () const
	Returns current loop delay.

void	addDelimiter (int delim, TimerEvent slot=0)
	Add frequency delimiter delim with optional delimiter slot slot.

void	removeDelimiter (int delim)
	Remove all frequency delimiters delim.

void	removeDelimiter (TimerEvent slot)
	Remove all frequency delimiters with slot slot.

void	removeDelimiter (int delim, TimerEvent slot)
	Remove all frequency delimiters delim with slot slot.

double	elapsed_n ()
	Returns nanoseconds elapsed from last reset() execution or from timer creation.

double	elapsed_u ()
	Returns microseconds elapsed from last reset() execution or from timer creation.

double	elapsed_m ()
	Returns milliseconds elapsed from last reset() execution or from timer creation.

double	elapsed_s ()
	Returns seconds elapsed from last reset() execution or from timer creation.

PISystemTime	reset_time ()
	Returns time mark of last reset() execution or timer creation.

Public Member Functions inherited from PIObject
	PIObject (const PIString &name=PIString())
	Contructs PIObject with name "name".

PIString	name () const
	Returns object name.

virtual const char *	className () const
	Returns object class name.

bool	debug () const
	Return if debug of this object is active.

void	setName (const PIString &name)
	Set object name.

void	setDebug (bool debug)
	Set object debug active.

const PIMap< PIString, PIVariant > &	properties () const
	Returns properties of the object.

int	propertiesCount () const
	Returns properties count of the object.

PIVariant	property (const PIString &name) const
	Returns property with name "name".

void	setProperty (const PIString &name, const PIVariant &value)
	Set property with name "name" to "value". If there is no such property in object it will be added.

bool	isPropertyExists (const PIString &name) const
	Returns if property with name "name" exists.

Static Public Member Functions
static double	elapsed_system_n ()
	Returns nanoseconds representation of current system time.

static double	elapsed_system_u ()
	Returns microseconds representation of current system time.

static double	elapsed_system_m ()
	Returns milliseconds representation of current system time.

static double	elapsed_system_s ()
	Returns seconds representation of current system time.

Static Public Member Functions inherited from PIObject
static void	piDisconnect (PIObject *src, const PIString &sig)
	Disconnect object "src" from all connections with event name "sig".

static void	piDisconnect (PIObject *src)
	Disconnect object "src" from all connections, i.e. all connections where object "src" is emitter.

static PIObject *	findByName (const PIString &name)
	Returns PIObject* with name "name" or 0, if there is no object found.

Protected Member Functions
virtual void	tick (void *data, int delimiter)

Protected Member Functions inherited from PIObject
PIObject *	emitter () const
	Returns PIObject* which has raised an event. This value is correct only in definition of some event handler.

virtual void	propertyChanged (const PIString &name)
	Virtual function executes after property with name "name" has been changed.

Handlers
void	reset ()
	Set internal time mark to current system time. More...

void	start (int msecs)
	Start timer with msecs loop delay. More...

void	start (double msecs)
	Start timer with msecs loop delay. More...

void	deferredStart (double interval_msecs, double delay_msecs)
	Start timer with interval_msecs loop delay after delay_msecs delay. More...

void	deferredStart (double interval_msecs, const PIDateTime &start_datetime)
	Start timer with interval_msecs loop delay after start_datetime date and time. More...

void	stop ()
	Stop timer.

void	clearDelimiters ()
	Remove all frequency delimiters.

Events
void	timeout (void *data, int delimiter)
	Raise on timer tick. More...

Additional Inherited Members
Related Functions inherited from PIObject
#define	piCoutObj
	Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject.

#define	PIOBJECT(name)
	you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output

#define	EVENT_HANDLER0(ret, name) ret name()
	declare event handler "event" with name "name" and return type "ret", ret name()

#define	EVENT_HANDLER1(ret, name, type0, var0) ret name(type0 var0)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0)

#define	EVENT_HANDLER2(ret, name, type0, var0, type1, var1) ret name(type0 var0, type1 var1)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1)

#define	EVENT_HANDLER3(ret, name, type0, var0, type1, var1, type2, var2) ret name(type0 var0, type1 var1, type2 var2)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_HANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_HANDLER EVENT_HANDLER0
	EVENT_HANDLER is synonym of EVENT_HANDLER0.

#define	EVENT_VHANDLER0(ret, name) virtual ret name()
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name()

#define	EVENT_VHANDLER1(ret, name, type0, var0) virtual ret name(type0 var0)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0)

#define	EVENT_VHANDLER2(ret, name, type0, var0, type1, var1) virtual ret name(type0 var0, type1 var1)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1)

#define	EVENT_VHANDLER3(ret, name, type0, var0, type1, var1, type2, var2) virtual ret name(type0 var0, type1 var1, type2 var2)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_VHANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_VHANDLER EVENT_VHANDLER0
	EVENT_VHANDLER is synonym of EVENT_VHANDLER0.

#define	EVENT0(name) void name();
	declare event "event" with name "name", void name();

#define	EVENT1(name, type0, var0) void name(type0 var0);
	declare event "event" with name "name", void name(type0 var0);

#define	EVENT2(name, type0, var0, type1, var1) void name(type0 var0, type1 var1);
	declare event "event" with name "name", void name(type0 var0, type1 var1);

#define	EVENT3(name, type0, var0, type1, var1, type2, var2) void name(type0 var0, type1 var1, type2 var2);
	declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2);

#define	EVENT4(name, type0, var0, type1, var1, type2, var2, type3, var3) void name(type0 var0, type1 var1, type2 var2, type3 var3);
	declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);

#define	EVENT EVENT0
	EVENT is synonym of EVENT0.

#define	CONNECT0(ret, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT1(ret, type0, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT2(ret, type0, type1, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT CONNECT0
	CONNECT is synonym of CONNECT0.

#define	WEAK_CONNECT0(ret, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT1(ret, type0, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT2(ret, type0, type1, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT WEAK_CONNECT0
	WEAK_CONNECT is synonym of WEAK_CONNECT0.

#define	DISCONNECT0(ret, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT1(ret, type0, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT2(ret, type0, type1, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT DISCONNECT0
	DISCONNECT is synonym of DISCONNECT0.

#define	HANDLER(handler)
	Returns pointer to events handler "handler".

Detailed Description

Timer.

Synopsis

This class implements timer function. PIP timers supports 3 way to tick notify, frequency delimiters and time measurements.

Notify variants

Notify variants:

"slot" - static function with format void func(void * data, int delimiter);
event - void timeout(void * data, int delimiter);
virtual function - void tick(void * data, int delimiter). All this variant are equivalent, use most applicable.

Frequency delimiters

Frequency delimiter is an integer number and "slot" function. If "slot" function is null timer main "slot" will be used. Each delimiter numbers tick timer will be execute delimiters or timer main "slot" function with delimiter value = delimiter number. Example:

void tfunc(void * , int delim) {
    piCout << "tick with delimiter" << delim;
};
void tfunc4(void * , int delim) {
    piCout << "tick4 with delimiter" << delim;
};
int main() {
    PITimer timer(tfunc);
    timer.addDelimiter(2);
    timer.addDelimiter(4, tfunc4);
    timer.start(50);
    piMSleep(200);
    timer.stop();
    timer.waitForFinish();
    return 0;
};
/* Result:
tick with delimiter 1
tick with delimiter 1
tick with delimiter 2
tick with delimiter 1
tick with delimiter 1
tick with delimiter 2
tick4 with delimiter 4
*/

Time measurements

PITimer can be used as time measurer. Function reset() set time mark to current system time, then functions double elapsed_*() returns time elapsed from this mark. These functions can returns nano-, micro-, milli- and seconds with suffixes "n", "u", "m" and "s"; Example:

int main() {
    PITimer timer;
    piMSleep(100);
    piCout << "elapsed" << timer.elapsed_m() << "ms";
    piMSleep(100);
    piCout << "elapsed" << timer.elapsed_m() << "ms";
    timer.reset();
    piMSleep(150);
    piCout << "elapsed" << timer.elapsed_s() << "s";
    return 0;
};
/* Result:
elapsed 100 ms
elapsed 200 ms
elapsed 0.15 s
*/

Member Function Documentation

void PITimer::reset ( )

inline

Set internal time mark to current system time.

This function used for set start time mark. Later you can find out elapsed time from this time mark to any moment of time with elapsed_s(), elapsed_m(), elapsed_u() or elapsed_n() function.

See Also: elapsed_s(), elapsed_m(), elapsed_u(), elapsed_n()

void PITimer::start ( int msecs )

inline

Start timer with msecs loop delay.

Start execution of timer functions with frequency = 1 / msecs Hz.

void PITimer::start ( double msecs )

Start timer with msecs loop delay.

Start execution of timer functions with frequency = 1. / msecs Hz. Instead of start(int msecs) function this variant allow start timer with frequencies more than 1 kHz.

void PITimer::deferredStart	(	double	interval_msecs,
		double	delay_msecs
	)

Start timer with interval_msecs loop delay after delay_msecs delay.

Timer wait delay_msecs milliseconds and then normally starts with interval_msecs loop delay.

See Also: void start(double msecs), void deferredStart(double interval_msecs, const PIDateTime & start_datetime)

void PITimer::deferredStart	(	double	interval_msecs,
		const PIDateTime &	start_datetime
	)

Start timer with interval_msecs loop delay after start_datetime date and time.

Timer wait until start_datetime and then normally starts with interval_msecs loop delay.

See Also: void start(double msecs), void deferredStart(double interval_msecs, double delay_msecs)

void PITimer::timeout	(	void *	data,
		int	delimiter
	)

Raise on timer tick.

Data can be set with function setData(void * data) or from constructor. Delimiter if frequency delimiter, 1 for main loop.

virtual void PITimer::tick	(	void *	data,
		int	delimiter
	)

inlineprotectedvirtual

Virtual timer execution function, similar to "slot" or event void timeout(void * data, int delimiter). By default is empty.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Handlers