mirror of
https://github.com/MarlinFirmware/Marlin.git
synced 2024-11-30 15:26:18 +00:00
118 lines
3.1 KiB
C++
118 lines
3.1 KiB
C++
/*
|
|
* Marlin 3D Printer Firmware
|
|
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
*
|
|
* Based on Sprinter and grbl.
|
|
* Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
|
|
*
|
|
* 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.
|
|
*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef STOPWATCH_H
|
|
#define STOPWATCH_H
|
|
|
|
#include "macros.h"
|
|
|
|
// Print debug messages with M111 S2 (Uses 156 bytes of PROGMEM)
|
|
//#define DEBUG_STOPWATCH
|
|
|
|
enum StopwatchState {
|
|
STOPWATCH_STOPPED,
|
|
STOPWATCH_RUNNING,
|
|
STOPWATCH_PAUSED
|
|
};
|
|
|
|
/**
|
|
* @brief Stopwatch class
|
|
* @details This class acts as a timer proving stopwatch functionality including
|
|
* the ability to pause the running time counter.
|
|
*/
|
|
class Stopwatch {
|
|
private:
|
|
StopwatchState state;
|
|
millis_t accumulator;
|
|
millis_t startTimestamp;
|
|
millis_t stopTimestamp;
|
|
|
|
public:
|
|
/**
|
|
* @brief Class constructor
|
|
*/
|
|
Stopwatch();
|
|
|
|
/**
|
|
* @brief Stops the stopwatch
|
|
* @details Stops the running timer, it will silently ignore the request if
|
|
* no timer is currently running.
|
|
* @return true is method was successful
|
|
*/
|
|
bool stop();
|
|
|
|
/**
|
|
* @brief Pause the stopwatch
|
|
* @details Pauses the running timer, it will silently ignore the request if
|
|
* no timer is currently running.
|
|
* @return true is method was successful
|
|
*/
|
|
bool pause();
|
|
|
|
/**
|
|
* @brief Starts the stopwatch
|
|
* @details Starts the timer, it will silently ignore the request if the
|
|
* timer is already running.
|
|
* @return true is method was successful
|
|
*/
|
|
bool start();
|
|
|
|
/**
|
|
* @brief Resets the stopwatch
|
|
* @details Resets all settings to their default values.
|
|
*/
|
|
void reset();
|
|
|
|
/**
|
|
* @brief Checks if the timer is running
|
|
* @details Returns true if the timer is currently running, false otherwise.
|
|
* @return true if stopwatch is running
|
|
*/
|
|
bool isRunning();
|
|
|
|
/**
|
|
* @brief Checks if the timer is paused
|
|
* @details Returns true if the timer is currently paused, false otherwise.
|
|
* @return true if stopwatch is paused
|
|
*/
|
|
bool isPaused();
|
|
|
|
/**
|
|
* @brief Gets the running time
|
|
* @details Returns the total number of seconds the timer has been running.
|
|
* @return the delta since starting the stopwatch
|
|
*/
|
|
millis_t duration();
|
|
|
|
#if ENABLED(DEBUG_STOPWATCH)
|
|
|
|
/**
|
|
* @brief Prints a debug message
|
|
* @details Prints a simple debug message "Stopwatch::function"
|
|
*/
|
|
static void debug(const char func[]);
|
|
|
|
#endif
|
|
};
|
|
|
|
#endif //STOPWATCH_H
|