6d8b3331d8
Doxygen skips undesired directories and files now. In addition, the documentation of the "fail" namespace has been fixed. Note that there are still several warnings (due to incomplete documentations) in the Doxygen output. Change-Id: Idad4f1ecff453765b307fa40a5c1cebc0c2ce2bb
83 lines
2.2 KiB
C++
83 lines
2.2 KiB
C++
/**
|
|
* \file CampaignManager.hpp
|
|
* \brief The manager for an entire campaign
|
|
*/
|
|
|
|
#ifndef __CAMPAIGN_MANAGER_HPP__
|
|
#define __CAMPAIGN_MANAGER_HPP__
|
|
|
|
#include "sal/SALInst.hpp"
|
|
#include "comm/ExperimentData.hpp"
|
|
#include "JobServer.hpp"
|
|
#include "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() : m_jobserver(0) { }
|
|
~CampaignManager() { delete m_jobserver; }
|
|
/**
|
|
* Executes a user campaign
|
|
*/
|
|
bool runCampaign(Campaign* c)
|
|
{
|
|
if (!m_jobserver) {
|
|
m_jobserver = new JobServer;
|
|
}
|
|
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(); }
|
|
/**
|
|
* User campaign has finished.
|
|
*/
|
|
void done() { m_jobserver->done(); }
|
|
/**
|
|
* Wait actively, until all experiments expired.
|
|
*/
|
|
// void waitForCompletion();
|
|
};
|
|
|
|
extern CampaignManager campaignmanager;
|
|
|
|
} // end-of-namespace: fail
|
|
|
|
#endif // __CAMPAIGN_MANAGER_HPP__
|