Merge pull request #1494 from NASA-AMMOS/documentation/streamline-loc…

…ator-guide Add a users guide to streamline resource framework
NASA-AMMOS · Aug 7, 2024 · bf29adf · bf29adf
2 parents 1ce729a + 8d7ab6c
commit bf29adf
Show file tree

Hide file tree

Showing 3 changed files with 1,409 additions and 0 deletions.
diff --git a/...ib/src/main/java/gov/nasa/jpl/aerie/contrib/streamline/modeling/clocks/VariableClock.java b/...ib/src/main/java/gov/nasa/jpl/aerie/contrib/streamline/modeling/clocks/VariableClock.java
@@ -26,4 +26,13 @@ public static VariableClock pausedStopwatch() {
   public static VariableClock pausedStopwatch(Duration time) {
     return new VariableClock(time, 0);
   }
+
+  public static VariableClock runningTimer(Duration timeRemaining) {
+    return new VariableClock(timeRemaining, -1);
+  }
+
+  public static VariableClock pausedTimer(Duration timeRemaining) {
+    // Identical to pausedStopwatch (could be condensed to just "paused", perhaps?)
+    return new VariableClock(timeRemaining, 0);
+  }
 }
diff --git a/...main/java/gov/nasa/jpl/aerie/contrib/streamline/modeling/clocks/VariableClockEffects.java b/...main/java/gov/nasa/jpl/aerie/contrib/streamline/modeling/clocks/VariableClockEffects.java
@@ -36,4 +36,11 @@ public static void reset(MutableResource<VariableClock> stopwatch) {
   public static void restart(MutableResource<VariableClock> stopwatch) {
     stopwatch.emit("Restart", effect(c -> runningStopwatch(ZERO)));
   }
+
+  /**
+   * Start counting down from current value.
+   */
+  public static void startCountdown(MutableResource<VariableClock> timer) {
+    timer.emit("Start Countdown", effect(c -> runningTimer(c.extract())));
+  }
 }