b7d904140e
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1319 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
78 lines
2.1 KiB
C++
78 lines
2.1 KiB
C++
/**
|
|
* \brief The manager for an entire campaign
|
|
*/
|
|
|
|
#ifndef __CAMPAIGN_MANAGER_HPP__
|
|
#define __CAMPAIGN_MANAGER_HPP__
|
|
|
|
#include "SAL/SALInst.hpp"
|
|
#include "ExperimentData.hpp"
|
|
#include "jobserver/JobServer.hpp"
|
|
#include "controller/Campaign.hpp"
|
|
|
|
namespace fail {
|
|
|
|
/**
|
|
* \class CampaignManager
|
|
*
|
|
* The CampaignManager allows a user-campaign access to all constant
|
|
* simulator information and forwards single experiments to the JobServer.
|
|
*/
|
|
class CampaignManager {
|
|
private:
|
|
JobServer m_jobserver;
|
|
Campaign* m_currentCampaign;
|
|
public:
|
|
CampaignManager() { }
|
|
/**
|
|
* Executes a user campaign
|
|
*/
|
|
bool runCampaign(Campaign* c)
|
|
{
|
|
m_currentCampaign = c;
|
|
bool ret = c->run();
|
|
m_jobserver.done();
|
|
return ret;
|
|
}
|
|
/**
|
|
* Returns a const reference for acquiring constant simulator specific information.
|
|
* e.g., Registernames, to ease experiment data construction.
|
|
* The campaign description is not allowed to change the simulator
|
|
* state, as the actual simulation runs within another process (Minion)
|
|
* @return constant reference to the current simulator backend.
|
|
*/
|
|
SimulatorController const& getSimulator() const { return simulator; }
|
|
/**
|
|
* Add a experiment parameter set.
|
|
* The user campaign has to allocate the Parameter object,
|
|
* and deallocate it after result reception.
|
|
* A Parameter set includes space for results.
|
|
* @param exp A pointer to a ExperimentData set.
|
|
*/
|
|
void addParam(ExperimentData* exp) { m_jobserver.addParam(exp); }
|
|
/**
|
|
* A user campaign can request a single result (blocking) from the queue.
|
|
* @return Pointer to a parameter object with filled result data
|
|
* @see addParam()
|
|
*/
|
|
ExperimentData* getDone() { return m_jobserver.getDone(); }
|
|
/**
|
|
* Signal, that there will not come any further parameter sets.
|
|
*/
|
|
void noMoreParameters() { m_jobserver.setNoMoreExperiments(); }
|
|
/**
|
|
* Wait actively, until all experiments expired.
|
|
*/
|
|
// void waitForCompletion();
|
|
/**
|
|
* User campaign has finished.
|
|
*/
|
|
void done() { m_jobserver.done(); }
|
|
};
|
|
|
|
extern CampaignManager campaignmanager;
|
|
|
|
} // end-of-namespace: fail
|
|
|
|
#endif // __CAMPAIGN_MANAGER_HPP__
|