72 lines
2.3 KiB
C++
72 lines
2.3 KiB
C++
/*
|
|
* Lightweight chronometer class.
|
|
* Simple chronometer/stopwatch class that counts the time passed since started.
|
|
*
|
|
* (c) 2015 Sofian Audry :: info(@)sofianaudry(.)com
|
|
* (c) 2015 Thomas O Fredericks :: tof(@)t-o-f(.)info
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#ifndef LIGHT_CHRONO_H_
|
|
#define LIGHT_CHRONO_H_
|
|
|
|
/*
|
|
* Example code:
|
|
*
|
|
* LightChrono myLightChrono; // chronometer automatically starts at creation
|
|
* // ...
|
|
* myLightChrono.restart(); // you can start (restart) it later
|
|
* while (!myLightChrono.hasPassed(2000)) // a 2000 ms loop
|
|
* Serial.println(myLightChrono.elapsed()); // current time
|
|
* // do something
|
|
* // ...
|
|
*/
|
|
class LightChrono
|
|
{
|
|
public:
|
|
#if defined(ARDUINO_ARC32_TOOLS)
|
|
typedef uint64_t chrono_t;
|
|
#else
|
|
typedef unsigned long chrono_t;
|
|
#endif
|
|
|
|
private:
|
|
chrono_t _startTime; // keeps track of start time (in milliseconds)
|
|
|
|
public:
|
|
/// Constructor.
|
|
LightChrono();
|
|
|
|
// Starts/restarts the chronometer.
|
|
void start();
|
|
void restart();
|
|
|
|
/// Returns the elapsed time since start (in milliseconds).
|
|
chrono_t elapsed() const;
|
|
|
|
/// Returns true iff elapsed time has passed given timeout.
|
|
bool hasPassed(chrono_t timeout) const;
|
|
bool hasPassed(chrono_t timeout, bool restartIfPassed);
|
|
};
|
|
|
|
#endif
|
|
|
|
|