Add timestamp functionality to PinHistory

Author: ianfixes

CHANGELOG.md

@@ -8,12 +8,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 ### Added
 * `release-new-version.sh` script
+* outputs for `PinHistory` can now report timestamps
 
 ### Changed
 * Shortened `ArduinoQueue` push and pop operations
 * `ci/Queue.h` is now `MockEventQueue.h`, with timing data
-* `MockEventQueue::Node` now contains struct `MockEvenntQueue::Event`, which contains both the templated type `T` and a field for a timestamp.
+* `MockEventQueue::Node` now contains struct `MockEventQueue::Event`, which contains both the templated type `T` and a field for a timestamp.
 * Construction of `MockEventQueue` now includes a constructor argument for the time-fetching function
+* Construction of `PinHistory` now includes a constructor argument for the time-fetching function
+* `PinHistory` can now return an array of timestamps for its events
 
 ### Deprecated
 

SampleProjects/TestSomething/test/pinhistory.cpp

@@ -1,9 +1,9 @@
 #include <ArduinoUnitTests.h>
 #include <Arduino.h>
+#include "fibonacciClock.h"
 
-
-unittest(pin_read_history) {
-  PinHistory<int> phi;
+unittest(pin_read_history_int) {
+  PinHistory<int> phi;  // pin history int
 
   const int future[6] = {33, 22, 55, 11, 44, 66};
   assertEqual(0, phi.queueSize());
@@ -16,8 +16,10 @@ unittest(pin_read_history) {
 
   // assert end of history works
   assertEqual(future[5], phi.retrieve());
+}
 
-  PinHistory<bool> phb;
+unittest(pin_read_history_bool_to_ascii) {
+  PinHistory<bool> phb;  // pin history bool
   phb.fromAscii("Yo", true);
 
   // digitial history as serial data, big-endian
@@ -32,7 +34,19 @@ unittest(pin_read_history) {
   assertEqual("Yo", phb.toAscii(0, true));
 }
 
-unittest(ascii_stuff) {
+unittest(assignment_dumps_queue) {
+  PinHistory<bool> phb;  // pin history bool
+  assertEqual(0, phb.queueSize());
+  assertEqual(0, phb.historySize());
+  phb.fromAscii("Yo", true);
+  assertEqual(16, phb.queueSize());
+  assertEqual(0, phb.historySize());
+  phb = false;
+  assertEqual(0, phb.queueSize());
+  assertEqual(1, phb.historySize());
+}
+
+unittest(ascii_to_bool_and_back) {
   PinHistory<bool> phb;
   assertEqual(0, phb.historySize());
   phb.reset(false);
@@ -50,4 +64,106 @@ unittest(ascii_stuff) {
   assertEqual("hi", phb.toAscii(1, true));
 }
 
+unittest(write_history) {
+  PinHistory<int> phi;  // pin history int
+  int expectedA[6] = {0, 11, 22, 33, 44, 55};
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(i, phi.historySize());
+    phi = expectedA[i];
+    assertEqual(i + 1, phi.historySize());
+    assertEqual(0, phi.queueSize());
+    assertEqual(phi, expectedA[i]);
+  }
+
+  int actualA[6];
+  int numMoved = phi.toArray(actualA, 6);
+  assertEqual(6, numMoved);
+  // assert non-destructive by repeating the operation
+  numMoved = phi.toArray(actualA, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(expectedA[i], actualA[i]);
+  }
+}
+
+unittest(null_timing) {
+  PinHistory<int> phi;  // pin history int
+  int expectedA[6] = {0, 11, 22, 33, 44, 55};
+  for (int i = 0; i < 6; ++i)
+  {
+    phi = expectedA[i];
+  }
+
+  unsigned long tStamps[6];
+  int numMoved = phi.toTimestampArray(tStamps, 6);
+  assertEqual(6, numMoved);
+  // assert non-destructive by repeating the operation
+  numMoved = phi.toTimestampArray(tStamps, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(0, tStamps[i]);
+  }
+}
+
+unittest(actual_timing_set_in_constructor) {
+  resetFibClock();
+  PinHistory<int> phi(fibMicros);  // pin history int
+  for (int i = 0; i < 6; ++i)
+  {
+    phi = 0;
+  }
+
+  int expectedT[6] = {1, 1, 2, 3, 5, 8};
+  unsigned long tStamps[6];
+  int numMoved = phi.toTimestampArray(tStamps, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(expectedT[i], tStamps[i]);
+  }
+}
+
+unittest(actual_timing_set_after_constructor) {
+  resetFibClock();
+  PinHistory<int> phi;  // pin history int
+  phi.setMicrosRetriever(fibMicros);
+  for (int i = 0; i < 6; ++i)
+  {
+    phi = 0;
+  }
+
+  int expectedT[6] = {1, 1, 2, 3, 5, 8};
+  unsigned long tStamps[6];
+  int numMoved = phi.toTimestampArray(tStamps, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(expectedT[i], tStamps[i]);
+  }
+}
+
+unittest(event_history) {
+  resetFibClock();
+  PinHistory<int> phi(fibMicros);  // pin history int
+  for (int i = 0; i < 6; ++i)
+  {
+    phi = i;
+  }
+
+  int expectedT[6] = {1, 1, 2, 3, 5, 8};
+  MockEventQueue<int>::Event event[6];
+  int numMoved = phi.toEventArray(event, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(i, event[i].data);
+    assertEqual(expectedT[i], event[i].micros);
+  }
+}
+
+
+
 unittest_main()

cpp/arduino/MockEventQueue.h

@@ -7,6 +7,7 @@ class MockEventQueue {
       T data;
       unsigned long micros;
 
+      Event() : data(T()), micros(0) {}
       Event(const T &d, unsigned long const t) : data(d), micros(t) { }
     };
 

cpp/arduino/PinHistory.h

@@ -59,15 +59,25 @@ class PinHistory : public ObservableDataStream {
       return ret;
     }
 
+    void init() {
+      asciiEncodingOffsetIn = 0;  // default is sensible
+      asciiEncodingOffsetOut = 1; // default is sensible
+    }
+
   public:
     unsigned int asciiEncodingOffsetIn;
     unsigned int asciiEncodingOffsetOut;
 
+    PinHistory(unsigned long (*getMicros)(void)) : ObservableDataStream(), qOut(getMicros) {
+      init();
+    }
+
     PinHistory() : ObservableDataStream() {
-      asciiEncodingOffsetIn = 0;  // default is sensible
-      asciiEncodingOffsetOut = 1; // default is sensible
+      init();
     }
 
+    void setMicrosRetriever(unsigned long (*getMicros)(void)) { qOut.setMicrosRetriever(getMicros); }
+
     void reset(T val) {
       clear();
       qOut.push(val);
@@ -135,7 +145,7 @@ class PinHistory : public ObservableDataStream {
     // copy data elements to an array, up to a given length
     // return the number of elements moved
     int toArray (T* arr, unsigned int length) const {
-      MockEventQueue<T> q2(qOut);
+      MockEventQueue<T> q2(qOut);  // preserve const by copying
 
       int ret = 0;
       for (int i = 0; i < length && q2.size(); ++i) {
@@ -146,10 +156,40 @@ class PinHistory : public ObservableDataStream {
       return ret;
     }
 
+    // copy pin history timing to an array, up to a given length.
+    // note that this records times between calls to the pin, not between transitions
+    // return the number of elements moved
+    int toTimestampArray(unsigned long* arr, unsigned int length) const {
+      MockEventQueue<T> q2(qOut);  // preserve const by copying
+
+      int ret = 0;
+      for (int i = 0; i < length && q2.size(); ++i) {
+        arr[i] = q2.frontTime();
+        q2.pop();
+        ++ret;
+      }
+      return ret;
+    }
+
+    // copy pin history timing to an array, up to a given length.
+    // note that this records times between calls to the pin, not between transitions
+    // return the number of elements moved
+    int toEventArray(typename MockEventQueue<T>::Event* arr, unsigned int length) const {
+      MockEventQueue<T> q2(qOut);  // preserve const by copying
+
+      int ret = 0;
+      for (int i = 0; i < length && q2.size(); ++i) {
+        arr[i] = q2.front();
+        q2.pop();
+        ++ret;
+      }
+      return ret;
+    }
+
     // see if the array matches the data of the elements in the queue
     bool hasElements (T const * const arr, unsigned int length) const {
       int i;
-      MockEventQueue<T> q2(qOut);
+      MockEventQueue<T> q2(qOut);  // preserve const by copying
       for (i = 0; i < length && q2.size(); ++i) {
         if (q2.frontData() != arr[i]) return false;
         q2.pop();