StartStop.hpp

Go to the documentation of this file.

/*
 *
 * ---
 *
 *  Copyright (C) 2022 Anselm Schmidt (ans[ät]ohai.su)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version in addition to the terms of any
 *  licences already herein identified.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * ---
 *
 * StartStop.hpp
 *
 * Start/stop watch timer for getting the elapsed time
 *  in milliseconds, including pausing functionality.
 *
 *  Created on: Oct 17, 2018
 *      Author: ans
 */

#ifndef TIMER_STARTSTOP_HPP_
#define TIMER_STARTSTOP_HPP_

#include "../Helper/DateTime.hpp"

#include <chrono>   // std::chrono
#include <string>   // std::string

namespace crawlservpp::Timer {

    /*
     * DECLARATION
     */


    class StartStop {
    public:

        StartStop();


        void start();
        void stop();
        void reset();


        std::string totalStr();


        void clear();


    protected:


        std::chrono::steady_clock::time_point timePoint;


        std::chrono::steady_clock::duration duration;

    };

    /*
     * IMPLEMENTATION
     */


    inline StartStop::StartStop()
     : timePoint(std::chrono::steady_clock::time_point::min()),
       duration(std::chrono::steady_clock::duration::zero()) {}


    inline void StartStop::start() {
        if(this->timePoint != std::chrono::steady_clock::time_point::min()) {
            this->stop();
        }

        this->timePoint = std::chrono::steady_clock::now();
    }


    inline void StartStop::stop() {
        this->duration += std::chrono::steady_clock::now() - this->timePoint;

        this->timePoint = std::chrono::steady_clock::time_point::min();
    }


    inline void StartStop::reset() {
        this->timePoint = std::chrono::steady_clock::time_point::min();
        this->duration = std::chrono::steady_clock::duration::zero();
    }


    inline std::string StartStop::totalStr() {
        if(this->timePoint != std::chrono::steady_clock::time_point::min()) {
            this->stop();
        }

        return Helper::DateTime::millisecondsToString(
                std::chrono::duration_cast<std::chrono::milliseconds>(
                        this->duration
                ).count()
        );
    }

    inline void StartStop::clear() {
        this->timePoint = std::chrono::steady_clock::time_point{};
        this->duration = std::chrono::steady_clock::duration{};
    }

} /* namespace crawlservpp::Timer */

#endif /* TIMER_STARTSTOPHR_HPP_ */