1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
|
/***********************************************/
/**
* @file loopTimeIntervals.h
*
* @brief Loop over time intervals.
*
* @author Torsten Mayer-Guerr
* @author Sebastian Strasser
* @date 2017-01-27
*
*/
/***********************************************/
#ifndef __GROOPS_LoopTimeIntervals__
#define __GROOPS_LoopTimeIntervals__
// Latex documentation
#ifdef DOCSTRING_Loop
static const char *docstringLoopTimeIntervals = R"(
\subsection{TimeIntervals}
Loop over the intervals between points in time.
)";
#endif
/***********************************************/
#include "base/import.h"
#include "classes/loop/loop.h"
#include "classes/timeSeries/timeSeries.h"
/***** CLASS ***********************************/
/** @brief Loop over time intervals.
* @ingroup loopGroup
* @see Loop */
class LoopTimeIntervals : public Loop
{
std::string nameTimeStart, nameTimeEnd, nameIndex, nameCount;
std::vector<Time> times;
public:
LoopTimeIntervals(Config &config);
UInt count() const override {return times.size()-1;}
Bool iteration(VariableList &varList) override;
};
/***********************************************/
/***** Inlines *********************************/
/***********************************************/
inline LoopTimeIntervals::LoopTimeIntervals(Config &config)
{
try
{
TimeSeriesPtr timesIntervalPtr;
readConfig(config, "timeIntervals", timesIntervalPtr, Config::MUSTSET, "", "loop is called for every interval");
readConfig(config, "variableLoopTimeStart", nameTimeStart, Config::OPTIONAL, "loopTime", "variable with starting time of each interval");
readConfig(config, "variableLoopTimeEnd", nameTimeEnd, Config::OPTIONAL, "loopTimeEnd", "variable with ending time of each interval");
readConfig(config, "variableLoopIndex", nameIndex, Config::OPTIONAL, "", "variable with index of current iteration (starts with zero)");
readConfig(config, "variableLoopCount", nameCount, Config::OPTIONAL, "", "variable with total number of iterations");
readConfigCondition(config);
if(isCreateSchema(config)) return;
times = timesIntervalPtr->times();
}
catch(std::exception &e)
{
GROOPS_RETHROW(e)
}
}
/***********************************************/
inline Bool LoopTimeIntervals::iteration(VariableList &varList)
{
if(index() >= count())
return FALSE;
if(!nameTimeStart.empty()) varList.setVariable(nameTimeStart, times.at(index()).mjd());
if(!nameTimeEnd.empty()) varList.setVariable(nameTimeEnd, times.at(index()+1).mjd());
if(!nameIndex.empty()) varList.setVariable(nameIndex, index());
if(!nameCount.empty()) varList.setVariable(nameCount, count());
return checkCondition(varList);
}
/***********************************************/
#endif
|