Gizmod::GizmodTimer Class Reference

Class for creating threads from the Python API. More...

#include <GizmodTimer.hpp>

Inheritance diagram for Gizmod::GizmodTimer:

[legend]

Collaboration diagram for Gizmod::GizmodTimer:

[legend]

List of all members.

Public Member Functions
void	cancel ()
	Cancel a timer's execution.
void	resetTimer ()
	Reset the timer's time.
void	setUserData (boost::python::object UserData)
	Set the Timer's user data.
void	setTime (float Seconds)
	Set the time to sleep before firing timer event.
void	start ()
	Start a timer's execution.
	GizmodTimer (float Seconds, boost::python::object TimerFunction)
	Default Constructor.
	GizmodTimer (float Seconds, boost::python::object TimerFunction, boost::python::object UserData)
	Init Constructor.
	GizmodTimer (float Seconds, boost::python::object TimerFunction, int Repeats, boost::python::object UserData)
	Init Constructor.
virtual	~GizmodTimer ()
	Destructor.
Classes
struct	GizmodTimerThreadProc

---

Detailed Description

Class for creating threads from the Python API.

Note that for some reason Python's threading API doesn't work very well embedded inside C++

Definition at line 60 of file GizmodTimer.hpp.

---

Constructor & Destructor Documentation

GizmodTimer::GizmodTimer	(	float	Seconds,
		boost::python::object	TimerFunction
	)

Default Constructor.

GizmodTimer Default Constructor.

Definition at line 59 of file GizmodTimer.cpp.

GizmodTimer::GizmodTimer	(	float	Seconds,
		boost::python::object	TimerFunction,
		boost::python::object	UserData
	)

Init Constructor.

GizmodTimer Init Constructor.

Definition at line 70 of file GizmodTimer.cpp.

References setUserData().

GizmodTimer::GizmodTimer	(	float	Seconds,
		boost::python::object	TimerFunction,
		int	Repeats,
		boost::python::object	UserData
	)

Init Constructor.

GizmodTimer Init Constructor.

Definition at line 82 of file GizmodTimer.cpp.

References setUserData().

GizmodTimer::~GizmodTimer

(

)

[virtual]

Destructor.

GizmodTimer Destructor.

Definition at line 94 of file GizmodTimer.cpp.

---

Member Function Documentation

void GizmodTimer::cancel

(

)

Cancel a timer's execution.

Create a thread and start its execution.

Definition at line 112 of file GizmodTimer.cpp.

References cdbg4.

void GizmodTimer::setUserData

(

boost::python::object

UserData

)

Set the Timer's user data.

Parameters:

UserData

User defined data

Definition at line 128 of file GizmodTimer.cpp.

Referenced by GizmodTimer().

void GizmodTimer::setTime

(

float

Seconds

)

Set the time to sleep before firing timer event.

Parameters:

Seconds

Time to sleep

Definition at line 136 of file GizmodTimer.cpp.

void GizmodTimer::start

(

)

Start a timer's execution.

Create a thread and start its execution.

Definition at line 104 of file GizmodTimer.cpp.

References cdbg4.

---

The documentation for this class was generated from the following files:

• libGizmod/GizmodTimer.hpp
• libGizmod/GizmodTimer.cpp

---