Automated Release 68 **NO_CI**

Team488 · Feb 24, 2024 · ca281c6 · ca281c6
1 parent 0c2d743
commit ca281c6
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 7 deletions.
diff --git a/index-all.html b/index-all.html
@@ -5427,6 +5427,11 @@ <h2 class="title" id="I:P">P</h2>
 <dd>&nbsp;</dd>
 <dt><a href="xbot/common/math/PlanarVisualizationPanel.html#paintComponent(java.awt.Graphics)" class="member-name-link">paintComponent(Graphics)</a> - Method in class xbot.common.math.<a href="xbot/common/math/PlanarVisualizationPanel.html" title="class in xbot.common.math">PlanarVisualizationPanel</a></dt>
 <dd>&nbsp;</dd>
+<dt><a href="xbot/common/logic/TimeStableValidator.html#peekStable()" class="member-name-link">peekStable()</a> - Method in class xbot.common.logic.<a href="xbot/common/logic/TimeStableValidator.html" title="class in xbot.common.logic">TimeStableValidator</a></dt>
+<dd>
+<div class="block">Checks if the value has been stable for the entire stable window duration, but without
+ updating the internal state of the validator.</div>
+</dd>
 <dt><a href="xbot/common/controls/actuators/XCANSparkMax.html#periodic()" class="member-name-link">periodic()</a> - Method in class xbot.common.controls.actuators.<a href="xbot/common/controls/actuators/XCANSparkMax.html" title="class in xbot.common.controls.actuators">XCANSparkMax</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="xbot/common/subsystems/BaseXCANTalonSpeedControlledSubsystem.html#periodic()" class="member-name-link">periodic()</a> - Method in class xbot.common.subsystems.<a href="xbot/common/subsystems/BaseXCANTalonSpeedControlledSubsystem.html" title="class in xbot.common.subsystems">BaseXCANTalonSpeedControlledSubsystem</a></dt>

diff --git a/member-search-index.js b/member-search-index.js
diff --git a/xbot/common/logic/TimeStableValidator.html b/xbot/common/logic/TimeStableValidator.html
@@ -118,19 +118,25 @@ <h2>Method Summary</h2>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Checks if the value has been stable for the entire stable window duration.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStable()" class="member-name-link">setStable</a>()</code></div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#peekStable()" class="member-name-link">peekStable</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Used if you want the validator to start in a stable state.</div>
+<div class="block">Checks if the value has been stable for the entire stable window duration, but without
+ updating the internal state of the validator.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStableWindow(double)" class="member-name-link">setStableWindow</a><wbr>(double&nbsp;stableWindow)</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStable()" class="member-name-link">setStable</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Update the stable window using a constant value.</div>
+<div class="block">Used if you want the validator to start in a stable state.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStableWindowProvider(java.util.function.Supplier)" class="member-name-link">setStableWindowProvider</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&gt;&nbsp;stableWindowProvider)</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStableWindow(double)" class="member-name-link">setStableWindow</a><wbr>(double&nbsp;stableWindow)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Update the stable window using a constant value.</div>
+</div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStableWindowProvider(java.util.function.Supplier)" class="member-name-link">setStableWindowProvider</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>&gt;&nbsp;stableWindowProvider)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Update the stable window using a supplier.</div>
 </div>
 </div>
@@ -216,6 +222,19 @@ <h3>checkStable</h3>
 </section>
 </li>
 <li>
+<section class="detail" id="peekStable()">
+<h3>peekStable</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">peekStable</span>()</div>
+<div class="block">Checks if the value has been stable for the entire stable window duration, but without
+ updating the internal state of the validator. (Example usage: the validator is updated
+ in a regular periodic call, but there are many listeners who are interested in the result.)</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>True if the last checkStable() call returned true.</dd>
+</dl>
+</section>
+</li>
+<li>
 <section class="detail" id="setStable()">
 <h3>setStable</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setStable</span>()</div>