SST::Exit Class Reference

#include <exit.h>

Inheritance diagram for SST::Exit:

Public Member Functions
	Exit (Simulation sim, TimeConverter period, bool single_rank)
	Create a new ExitEvent.
bool	refInc (ComponentId_t)
	Increment Reference Count for a given Component ID.
bool	refDec (ComponentId_t)
	Decrement Reference Count for a given Component ID.
void	execute (void)
	Function which will be called when the time for this Activity comes to pass.
void	check ()
void	print (const std::string &header, Output &out) const
	Generic print-print function for this Activity.
Friends
class	boost::serialization::access

Detailed Description

Exit Event Action.

Causes the simulation to halt

Constructor & Destructor Documentation

SST::Exit::Exit	(	Simulation *	sim,
		TimeConverter *	period,
		bool	single_rank
	)

Create a new ExitEvent.

Parameters:

	sim	- Simulation Object
	period	- Period upon which to check for exit status
	single_rank	- True if there are no parallel ranks

Exit needs to register a handler during constructor time, which requires a simulation object. But the simulation class creates an Exit object during it's construction, meaning that Simulation::getSimulation() won't work yet. So Exit is the one exception to the "constructors shouldn't take simulation pointers" rule. However, it still needs to follow the "classes shouldn't contain pointers back to Simulation" rule.

References SST::Activity::setPriority().