Fail* directories reorganized, Code-cleanup (-> coding-style), Typos+comments fixed.

git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1321 8c4709b5-6ec9-48aa-a5cd-a96041d1645a

src/core/efw/ExperimentFlow.hpp

@@ -0,0 +1,37 @@
+#ifndef __EXPERIMENT_FLOW_HPP__
+  #define __EXPERIMENT_FLOW_HPP__
+
+#include "sal/SALInst.hpp"
+
+namespace fail {
+
+/**
+ * \class ExperimentFlow
+ * Basic interface for user-defined experiments. To create a new experiment,
+ * derive your own class from ExperimentFlow and define the run method.
+ */
+class ExperimentFlow {
+public:
+	ExperimentFlow() { }
+	/**
+	 * Defines the experiment flow.
+	 * @return \c true if the experiment was successful, \c false otherwise
+	 */
+	virtual bool run() = 0;
+	/**
+	 * The entry point for this experiment's coroutine.
+	 * Should do some cleanup afterwards.
+	 */
+	void coroutine_entry()
+	{
+		run();
+		simulator.clearEvents(this); // remove residual events
+		// FIXME: Consider removing this call (see EventList.cc, void remove(ExperimentFlow* flow)) 
+		//        a) with the advantage that we will potentially prevent serious segfaults but
+		//        b) with the drawback that we cannot enforce any cleanups.
+	}
+};
+
+} // end-of-namespace: fail
+
+#endif // __EXPERIMENT_FLOW_HPP__