ScopedStopWatch.h

Go to the documentation of this file.

#pragma once
 
 
#include <functional>
 
#include <IceUtil/Time.h>
 
#include <ArmarXCore/core/time/StopWatch.h>
#include <ArmarXCore/core/time/TimeUtil.h>
 
 
namespace armarx::core::time
{
 
    /**
     * @brief Measures the time this stop watch was inside the current scope.  Takes a lambda as
     * construction parameter (taking an `IceUtil::Time` as parameter), which will be called at
     * destruction (i.e., when the scope was left).
     *
     * Code example:
     *
     * @code
     * {
     *     ScopedStopWatch sw{[](const Duration& duration) {
     *         std::cout << "Operation took " << duration << ".";
     *     }};
     *
     *     long_operation();
     * }
     * @endcode
     */
    class ScopedStopWatch : public StopWatch
    {
 
    public:
        /**
         * @brief Constructs a `ScopedStopWatch`.
         * @param callback Callback lambda which will be called at destruction with measured time.
         * @param clockType Clock type.
         */
        ScopedStopWatch(std::function<void(const Duration&)> callback,
                        ClockType clockType = ClockType::Virtual);
 
        /**
         * @brief Destructs the `ScopedStopWatch`.
         */
        virtual ~ScopedStopWatch() override;
 
    private:
        std::function<void(const Duration&)> _callback;
    };
 
} // namespace armarx::core::time
 
 
namespace armarx
{
 
    class [[deprecated("Use armarx::core::time::ScopedStopWatch instead")]] ScopedStopWatch :
        public StopWatch
    {
 
    public:
        ScopedStopWatch(std::function<void(IceUtil::Time)> callback,
                        armarx::TimeMode timeMode = armarx::TimeMode::SystemTime);
        virtual ~ScopedStopWatch() override;
 
    private:
        std::function<void(IceUtil::Time)> m_callback;
    };
 
} // namespace armarx