Files
fail/core/controller/ExperimentFlow.hpp

39 lines
1.0 KiB
C++

#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__