FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
timer.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_TIMER_H
23 #define FIFE_TIMER_H
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 #include <boost/function.hpp>
29 
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 #include "timeevent.h"
35 
36 namespace FIFE {
37 
61  class Timer : protected TimeEvent {
62  public:
63  typedef boost::function0<void> type_callback;
64 
70  Timer();
71 
76  virtual ~Timer();
77 
83  void setInterval(int32_t msec);
84 
90  void start();
91 
97  void stop();
98 
103  void setCallback(const type_callback& callback);
104 
105  protected:
106  bool m_active;
107  type_callback m_callback;
108  void updateEvent(uint32_t);
109  };
110 
111 }//FIFE
112 
113 #endif
bool m_active
Definition: timer.h:106
void setInterval(int32_t msec)
Set the interval in milliseconds.
Definition: timer.cpp:60
void start()
Start the timer.
Definition: timer.cpp:45
Interface for events to be registered with TimeManager.
Definition: timeevent.h:48
type_callback m_callback
Definition: timer.h:107
boost::function0< void > type_callback
Definition: timer.h:63
void stop()
Stop the timer.
Definition: timer.cpp:53
Timer()
Default constructor.
Definition: timer.cpp:36
virtual ~Timer()
Destructor.
Definition: timer.cpp:41
Simple Timer class.
Definition: timer.h:61
unsigned int uint32_t
Definition: core.h:40
void setCallback(const type_callback &callback)
Set the callback that will be called.
Definition: timer.cpp:64
void updateEvent(uint32_t)
Update function to be overridden by client.
Definition: timer.cpp:68