Timer.h

/*
 * A header file for a timer to keep track of the time passed
 *
 * Author wba6
 */

#ifndef PERFORMANCE_ANALYER_TIMER_H
#define PERFORMANCE_ANALYER_TIMER_H

#include <memory>
#include <chrono>
#include <string>

/*
 * A timer class to keep track of the time passed between two events
 */
class Timer {
public:

    /*
     * Constructor for the Timer class
     *
     * @param std::string name : the name of the timer
     * @return void
     */
    Timer(std::string name);

    /*
     * Destructor for the Timer class
     *
     * @param None
     * @return void
     */
    ~Timer();

    /*
     * Start the timer
     *
     * @param None
     * @return void
     */
    void start();

    /*
     * Stop the timer
     *
     * @param None
     * @return void
     */
    void stop();
private:
    // timer name
    std::string m_name;

    // start time of the timer
    std::chrono::time_point<std::chrono::high_resolution_clock> m_startTime;

    // end time of the timer
    std::chrono::time_point<std::chrono::high_resolution_clock> m_endTime;

    // has the timer already stoped
    bool m_stopped;
};


#endif //PERFORMANCE_ANALYER_TIMER_H