SimEventBreak Class Reference

Request to break the simulation. More...

#include <Simulation/SimEvents.H>

Inheritance diagram for SimEventBreak:

[legend]

Collaboration diagram for SimEventBreak:

[legend]

List of all members.

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

---

Detailed Description

Request to break the simulation.

Post this and the next SimEventQueue::evolve() we will return with a break status, usually resulting in terminating the simulation.

Definition at line 54 of file SimEvents.H.

---

Constructor & Destructor Documentation

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

Constructor.

Definition at line 42 of file SimEvents.C.

SimEventBreak::~SimEventBreak

(

)

[virtual]

Destructor.

Definition at line 46 of file SimEvents.C.

---

Member Function Documentation

std::string SimEventBreak::toString

(

)

const [virtual]

Explain why we break.

Reimplemented from SimEvent.

Definition at line 49 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