SoSystemTimer Class Reference

Common interface to expose system dependent timers More...

#include <Inventor/sensors/SoSystemTimer.h>

Inheritance diagram for SoSystemTimer:

Public Member Functions
virtual void	start ()=0
	Start the timer.
virtual void	stop ()=0
	Stop the timer.
virtual void	setDelay (int time)=0
	Set the timer's timeout in milliseconds.
virtual bool	isPending () const =0
	Return true if the timer is running.
virtual void	setRepeat (bool flag)=0
	If set to true, the timer will be triggered periodically at the rate defined by setDelay.
virtual void	setTask (SoSystemTimerTask *task)=0
	Sets the task executed when the timer is triggered.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.

Detailed Description

Common interface to expose system dependent timers

The timer implementation usually depends on the window toolkit used (Qt, Awt, Swt...). The purpose of this class is to expose a common interface for system dependent timers. When the timer is triggered, it must call the run() method of its SoSystemTimerTask (given by the setTask method).

SEE ALSO

SoSensorHandler

Definition at line 50 of file SoSystemTimer.h.

Member Function Documentation

isPending()

virtual bool SoSystemTimer::isPending ( ) const

pure virtual

Return true if the timer is running.

Implemented in WinTimer, QtTimer, and WinTimer.

setDelay()

virtual void SoSystemTimer::setDelay ( int  time )

pure virtual

Set the timer's timeout in milliseconds.

Implemented in WinTimer, QtTimer, and WinTimer.

setRepeat()

virtual void SoSystemTimer::setRepeat ( bool  flag )

pure virtual

If set to true, the timer will be triggered periodically at the rate defined by setDelay.

Implemented in WinTimer, QtTimer, and WinTimer.

setTask()

virtual void SoSystemTimer::setTask ( SoSystemTimerTask *  task )

pure virtual

Sets the task executed when the timer is triggered.

When the timer is is triggered, it calls the run() method of task.

Implemented in WinTimer, QtTimer, and WinTimer.

start()

virtual void SoSystemTimer::start ( )

pure virtual

Start the timer.

If it is already started, stop it and restart

Implemented in WinTimer, QtTimer, and WinTimer.

stop()

virtual void SoSystemTimer::stop ( )

pure virtual

Stop the timer.

Implemented in WinTimer, QtTimer, and WinTimer.

---

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

• Inventor/sensors/SoSystemTimer.h