aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/stopwatch/StopWatchController.h
blob: bcc9b5515cbe55482ecd550961502ef354f0d766 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#pragma once

#include <FreeRTOS.h>
#include <optional>
#include <timers.h>
#include "utility/CircularBuffer.h"

namespace Pinetime {
  namespace System {
    class SystemTask;
  }

  namespace Controllers {

    enum class StopWatchStates { Cleared, Running, Paused };

    struct LapInfo {
      int number = 0;                // Used to label the lap
      TickType_t timeSinceStart = 0; // Excluding pauses
    };

    class StopWatchController {
    public:
      StopWatchController();

      // StopWatch functionality and data
      void Start();
      void Pause();
      void Clear();

      TickType_t GetElapsedTime();

      // Lap functionality

      /// Only the latest histSize laps are stored
      void AddLapToHistory();

      /// Returns maxLapNumber
      int GetMaxLapNumber();

      /// Indexes into lap history, with 0 being the latest lap.
      std::optional<LapInfo> GetLapFromHistory(int index);

      bool IsRunning();
      bool IsCleared();
      bool IsPaused();

    private:
      // Time at which stopwatch wraps around to zero (1000 hours)
      static constexpr TickType_t elapsedTimeBoundary = (TickType_t) configTICK_RATE_HZ * 60 * 60 * 1000;
      // Current state of stopwatch
      StopWatchStates currentState = StopWatchStates::Cleared;
      // Start time of current duration
      TickType_t startTime;
      // How much time was elapsed before current duration
      TickType_t timeElapsedPreviously;

      // Maximum number of stored laps
      static constexpr int histSize = 4;
      // Value at which lap numbers wrap around to zero
      static constexpr int lapNumberBoundary = 1000;
      // Lap storage
      Utility::CircularBuffer<LapInfo, histSize> history;
      // Highest lap number; less than lapNumberBoundary, may exceed histSize
      int maxLapNumber;
    };
  }
}