basic_timer.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Rene Schmieding
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_TIMER_BASIC_TIMER_H
#define MIO_TIMER_BASIC_TIMER_H
 
#include "memilio/io/io.h"
#include "memilio/timer/definitions.h"
 
#include <string_view>
#include <utility>
 
namespace mio
{
namespace timing
{
 
class BasicTimer
{
public:
    void start()
    {
        should_be_running(false, "start");
        set_running(true);
        m_start_time = get_time_now();
    }
 
    void stop()
    {
        should_be_running(true, "stop");
        set_running(false);
        const TimeType stop_time = get_time_now();
        m_elapsed_time += stop_time - m_start_time;
    }
 
    void reset()
    {
        should_be_running(false, "reset");
        m_elapsed_time = mio::timing::DurationType{0};
    }
 
    DurationType get_elapsed_time() const
    {
        should_be_running(false, "get_elapsed_time");
        return m_elapsed_time;
    }
 
    ~BasicTimer()
    {
        should_be_running(false, "~BasicTimer");
    }
 
    template <class IOContext>
    void serialize(IOContext& io) const
    {
        auto obj = io.create_object("BasicTimer");
        obj.add_element("elapsed_time", details::convert_to_ticks(m_elapsed_time));
    }
 
    template <class IOContext>
    static IOResult<BasicTimer> deserialize(IOContext& io)
    {
        using Tick = decltype(details::convert_to_ticks(std::declval<DurationType>()));
        auto obj   = io.expect_object("BasicTimer");
        auto et    = obj.expect_element("elapsed_time", Tag<Tick>{});
        return apply(
            io,
            [](auto&& et_) {
                BasicTimer b;
                b.m_elapsed_time = DurationType{et_};
                return b;
            },
            et);
    }
 
private:
    TimeType m_start_time; 
    DurationType m_elapsed_time{0}; 
 
#ifndef NDEBUG
    bool m_is_running = false; 
#endif
 
    void set_running(bool new_state);
 
    void should_be_running(bool expected, const std::string_view function) const;
};
 
} // namespace timing
} // namespace mio
 
#endif // MIO_TIMER_BASIC_TIMER_H