Iterator.hpp

Go to the documentation of this file.

 
#ifndef SRC_INCLUDE_ITERATOR_HPP
#define SRC_INCLUDE_ITERATOR_HPP
 
#include "Logged.hpp"
#include "Time.hpp"
 
namespace Nextsim {
 
class Iterator {
public:
    typedef TimePoint::Clock Clock;
    class Iterant;
 
    Iterator();
    Iterator(Iterant* iterant);
 
    void setIterant(Iterant* iterant);
 
    void setStartStopStep(TimePoint startTime, TimePoint stopTime, Duration timestep);
    void setStartDurationStep(TimePoint startTime, Duration duration, Duration timestep);
 
    TimePoint parseAndSet(const std::string& startTimeStr, const std::string& stopTimeStr,
        const std::string& durationStr, const std::string& stepStr);
    void run();
 
private:
    Iterant* iterant; // FIXME smart pointer
    TimePoint startTime;
    TimePoint stopTime;
    Duration timestep;
 
public:
    class Iterant {
    public:
        // Define the constructors and copy operator as default to be
        // rule of 5 compliant, given the virtual destructor
        Iterant() = default;
        Iterant(const Iterant& copyFrom) = default;
        Iterant& operator=(const Iterant& copyFrom) = default;
        Iterant(Iterant&&) = default;
        Iterant& operator=(Iterant&&) = default;
 
        virtual ~Iterant() = default;
 
        virtual void init() = 0;
        virtual void start(const TimePoint& startTime) = 0;
        virtual void iterate(const TimestepTime& dt) = 0;
        virtual void stop(const TimePoint& stopTime) = 0;
    };
 
    class NullIterant : public Iterant {
        inline void init() {};
        inline void start(const TimePoint& startTime) {};
        inline void iterate(const TimestepTime& dt) {};
        inline void stop(const TimePoint& stopTime) {};
    };
 
    static NullIterant nullIterant;
};
 
} /* namespace Nextsim */
 
#endif /* SRC_INCLUDE_ITERATOR_HPP */