File: timer.h

package info (click to toggle)
clanlib 0.5.4-1-6
  • links: PTS
  • area: main
  • in suites: woody
  • size: 10,320 kB
  • ctags: 10,893
  • sloc: cpp: 76,056; xml: 3,281; sh: 2,961; perl: 1,204; asm: 837; makefile: 775
file content (71 lines) | stat: -rw-r--r-- 1,728 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
	$Id: timer.h,v 1.12 2001/12/01 17:49:21 sphair Exp $

	------------------------------------------------------------------------
	ClanLib, the platform independent game SDK.

	This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
	version 2. See COPYING for details.

	For a total list of contributers see CREDITS.

	See http://www.clanlib.org
	------------------------------------------------------------------------
*/

//! clanCore="System"
//! header=core.h

#ifndef header_timer
#define header_timer

#include "keep_alive.h"
#include "../../signals.h"

//: Timer signal emitter.
//- Use this class to emit a signal as a timer event.
class CL_Timer : public CL_KeepAlive
{
//! Construction:
public:
	//: Constructs and registers the timer as a keep_alive listener.
	//: Note that it is disabled by default, so you need to enable() it.
	//- interval - Interval in millisecs between each signal emit.
	CL_Timer(unsigned long interval = 1000);
	
//! Attributes:
public:
	//: Returns the current time interval.
	//- Returns - The current time interval.
	unsigned long get_interval();

	//: Returns true if the timer is enabled, false otherwise.
	bool is_enabled();

//! Operations:
public:
	//: Sets a new interval for the timer.
	//- interval - Interval in millisecs between each signal emit.
	void set_interval(unsigned long interval);

	//: Call this function to enable the timer.
	void enable();
	
	//: Call this function to disable the timer.
	void disable();
	
//! Signals:
public:
	//: Signal emitted everytime the interval has elapsed.
	CL_Signal_v0 sig_timer;
	
//! Implementation:
private:
	virtual void keep_alive();

	unsigned long interval;
	unsigned long last_time;
	bool enabled;
};

#endif