Wait.h

Go to the documentation of this file.

/**
 * @file Wait.h
 * @brief Utility class for handling non-blocking wait operations.
 *
 * @date 22/12/2024
 * @version 1.0
 * @author Coela Can't
 */
 
#pragma once
 
#include <Arduino.h>
 
/**
 * @class Wait
 * @brief Provides a mechanism to wait for a specified duration without blocking.
 */
class Wait {
private:
    unsigned long previousMillis; ///< Stores the last recorded time in milliseconds.
    unsigned long millisToWait;   ///< Duration to wait in milliseconds.
 
public:
    /**
     * @brief Constructor to initialize Wait with a duration.
     * @param millisToWait The duration to wait in milliseconds.
     */
    Wait(unsigned long millisToWait);
 
    /**
     * @brief Resets the wait timer to start counting again.
     */
    void Reset();
 
    /**
     * @brief Checks if the specified duration has elapsed.
     * @return True if the duration has elapsed, otherwise false.
     */
    bool IsFinished();
};