Pause.H File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PauseWaiter
	Simple class to help main loops handle pause/unpause events. More...
Functions
void	setPause (bool on)
	Change in to or out of the paused state.
bool	isPaused ()
	Check if we are in the paused state.
int	waitForPause (const int usecs=50000)
	Check if we are in the paused state, and if so, loop until we become unpaused.

---

Detailed Description

simple global pause toggle

Definition in file Pause.H.

---

Function Documentation

bool isPaused

(

)

Check if we are in the paused state.

Definition at line 58 of file Pause.C.

Referenced by PauseWaiter::checkPause().

void setPause

(

bool

on

)

Change in to or out of the paused state.

Note that this actually does nothing itself; all it does is change the result of isPaused(). Individual applications can check isPaused() in their main loops and act accordingly; or, they equally well just ignore isPaused() if they don't care to pause.

Definition at line 53 of file Pause.C.

int waitForPause

(

const int

usecs = 50000

)

Check if we are in the paused state, and if so, loop until we become unpaused.

Returns:

how many wait cycles were spent waiting to become unpaused