SimEventUserWait Class Reference

Wait until user presses RETURN key. More...

#include <Simulation/SimEvents.H>

Inheritance diagram for SimEventUserWait:

[legend]

Collaboration diagram for SimEventUserWait:

[legend]

List of all members.

Public Member Functions
	SimEventUserWait (SimModule *src, const std::string &reason="")
	Constuctor.
virtual	~SimEventUserWait ()
	Destructor.
virtual std::string	toString () const
	Explain why we pause.

---

Detailed Description

Wait until user presses RETURN key.

A SimModule may post this to request that the simulation be paused until the user presses the RETURN key. For example, this may be used after a bunch of images have been displayed, to give the user the time to examine them before continuing with the simulation. This event is handled directly at the very beginning of SimEventQueue::evolve(), just before we increment the clock. The event is displayed, plus a message to invite the user to press RETURN to continue.

Definition at line 79 of file SimEvents.H.

---

Constructor & Destructor Documentation

SimEventUserWait::SimEventUserWait	(	SimModule *	src,
		const std::string &	reason = ""
	)

Constuctor.

Definition at line 58 of file SimEvents.C.

SimEventUserWait::~SimEventUserWait

(

)

[virtual]

Destructor.

Definition at line 63 of file SimEvents.C.

---

Member Function Documentation

std::string SimEventUserWait::toString

(

)

const [virtual]

Explain why we pause.

Reimplemented from SimEvent.

Definition at line 66 of file SimEvents.C.

References sformat(), and SimEvent::toString().

---

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

• src/Simulation/SimEvents.H
• src/Simulation/SimEvents.C