christoph/fail
1
Fork 0
Code Releases Activity

Typos and doxygen comments fixed.

Browse Source 
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@986 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
adrian
2012-03-12 15:17:18 +00:00
parent a2681d7fa1
commit 2750856a16
3 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/controller/CampaignManager.hpp
View File

@ -42,11 +42,11 @@ class CampaignManager
}
/**
* Returns a const reference for acquiring constant simlator specific information.
* 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 c constant reference to the current simulator backend.
* @return constant reference to the current simulator backend.
*/
sal::SimulatorController const& getSimulator() const { return sal::simulator; };
@ -57,12 +57,13 @@ class CampaignManager
* A Parameter set includes space for results.
* @param exp A pointer to a ExperimentData set.
*/
void addParam(ExperimentData* exp){ m_jobserver.addParam(exp); };
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.
* @return Pointer to a parameter object with filled result data
* @see addParam.
*/
ExperimentData* getDone() { return m_jobserver.getDone(); };
@ -77,7 +78,7 @@ class CampaignManager
// void waitForCompletion();
/**
* User campaign has finished..
* User campaign has finished.
*/
void done() { m_jobserver.done(); };

8
core/jobserver/JobClient.cc
View File

@ -39,11 +39,11 @@ bool JobClient::connectToServer(){
}
bool JobClient::getParam(ExperimentData& exp){
while(1) { //!< Here we try to acquire a parameter set
while(1) { // Here we try to acquire a parameter set
switch(tryToGetExperimentData(exp)){
//!< Jobserver will sent workload, params are set in \c exp
// Jobserver will sent workload, params are set in \c exp
case FailControlMessage_Command_WORK_FOLLOWS: return true;
//!< Nothing to do right now, but maybe later
// Nothing to do right now, but maybe later
case FailControlMessage_Command_COME_AGAIN:
sleep(1);
continue;
@ -54,7 +54,7 @@ bool JobClient::getParam(ExperimentData& exp){
}
FailControlMessage_Command JobClient::tryToGetExperimentData(ExperimentData& exp)
{
//!< Connection failed, minion can die
// Connection failed, minion can die
if( !connectToServer() ) return FailControlMessage_Command_DIE;
// Retrieve ExperimentData

8
core/jobserver/JobClient.hpp
View File

@ -39,17 +39,17 @@ namespace fi {
* allocating his ExperimentData object.
*
* @param exp Reference to a ExperimentData object allocated by the caller!
* @result \c true if parameter have been received and put into \c exp, \c false else.
* @return \c true if parameter have been received and put into \c exp, \c false else.
*/
bool getParam(ExperimentData& exp);
/**
* Send back experiment result to the (remote) JobServer
* Send back experiment result to the (remote) JobServer
* The caller (experiment developer) is responsible for
* destroying his ExperimentData object afterwards.
*
* @param exp Reference to the ExperimentData holding result values
* @return \c true Result successfully sent, \c else.
* @param result Reference to the ExperimentData holding result values
* @return \c true Result successfully sent, \c false else.
*/
bool sendResult(ExperimentData& result);