second edits of threshold/plateau

deleted time (integrated time test into threshold and plateau)
Team3128 · May 31, 2024 · 76bcdb4 · 76bcdb4
1 parent 85675e1
commit 76bcdb4
Show file tree

Hide file tree

Showing 15 changed files with 422 additions and 426 deletions.
diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
@@ -221,7 +221,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Team 3128's Pivot Template class.</div>
 </div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Plateau.html" title="class in common.utility.tester">Plateau</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/PlateauTest.html" title="class in common.utility.tester">PlateauTest</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/sysid/PolynomialDerivative.html" title="class in common.utility.sysid">PolynomialDerivative</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -276,12 +276,10 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">System test</div>
 </div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Threshold.html" title="class in common.utility.tester">Threshold</a></div>
+<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/ThresholdTest.html" title="class in common.utility.tester">ThresholdTest</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Time.html" title="class in common.utility.tester">Time</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
-<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/core/controllers/TrapController.html" title="class in common.core.controllers">TrapController</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/core/controllers/TrapController.html" title="class in common.core.controllers">TrapController</a></div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Team 3128's streamlined <code>ProfiledPIDController</code> class.</div>
 </div>
 </div>

diff --git a/doc/common/utility/tester/Plateau.html → doc/common/utility/tester/PlateauTest.html b/doc/common/utility/tester/Plateau.html → doc/common/utility/tester/PlateauTest.html
diff --git a/doc/common/utility/tester/Tester.UnitTest.html b/doc/common/utility/tester/Tester.UnitTest.html
@@ -82,7 +82,7 @@ <h1 title="Class Tester.UnitTest" class="title">Class Tester.UnitTest</h1>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
-<dd><code><a href="CurrentTest.html" title="class in common.utility.tester">CurrentTest</a></code>, <code><a href="../../core/subsystems/NAR_PIDSubsystem.SetpointTest.html" title="class in common.core.subsystems">NAR_PIDSubsystem.SetpointTest</a></code>, <code><a href="Plateau.html" title="class in common.utility.tester">Plateau</a></code>, <code><a href="Threshold.html" title="class in common.utility.tester">Threshold</a></code></dd>
+<dd><code><a href="CurrentTest.html" title="class in common.utility.tester">CurrentTest</a></code>, <code><a href="../../core/subsystems/NAR_PIDSubsystem.SetpointTest.html" title="class in common.core.subsystems">NAR_PIDSubsystem.SetpointTest</a></code>, <code><a href="PlateauTest.html" title="class in common.utility.tester">PlateauTest</a></code>, <code><a href="ThresholdTest.html" title="class in common.utility.tester">ThresholdTest</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing class:</dt>

diff --git a/doc/common/utility/tester/Threshold.html → doc/common/utility/tester/ThresholdTest.html b/doc/common/utility/tester/Threshold.html → doc/common/utility/tester/ThresholdTest.html
@@ -2,10 +2,10 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Threshold (3128-common)</title>
+<title>ThresholdTest (3128-common)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="description" content="declaration: package: common.utility.tester, class: Threshold">
+<meta name="description" content="declaration: package: common.utility.tester, class: ThresholdTest">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
@@ -68,12 +68,12 @@
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">common.utility.tester</a></div>
-<h1 title="Class Threshold" class="title">Class Threshold</h1>
+<h1 title="Class ThresholdTest" class="title">Class ThresholdTest</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">edu.wpi.first.wpilibj2.command.Command
 <div class="inheritance"><a href="Tester.UnitTest.html" title="class in common.utility.tester">common.utility.tester.Tester.UnitTest</a>
-<div class="inheritance">common.utility.tester.Threshold</div>
+<div class="inheritance">common.utility.tester.ThresholdTest</div>
 </div>
 </div>
 </div>
@@ -83,7 +83,7 @@ <h1 title="Class Threshold" class="title">Class Threshold</h1>
 <dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
 </dl>
 <hr>
-<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Threshold</span>
+<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ThresholdTest</span>
 <span class="extends-implements">extends <a href="Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></span></div>
 </section>
 <section class="summary">
@@ -126,18 +126,33 @@ <h2>Constructor Summary</h2>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
-<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.function.DoubleSupplier,double)" class="member-name-link">Threshold</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.BooleanSupplier)" class="member-name-link">ThresholdTest</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
+ double&nbsp;timeOut,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a>&nbsp;passCondition)</code></div>
+<div class="col-last even-row-color">
+<div class="block">Creates a threshold test.</div>
+</div>
+<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.BooleanSupplier)" class="member-name-link">ThresholdTest</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a>&nbsp;passCondition)</code></div>
+<div class="col-last odd-row-color">
+<div class="block">Creates a threshold test.</div>
+</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.DoubleSupplier,double)" class="member-name-link">ThresholdTest</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a>&nbsp;measurement,
  double&nbsp;threshold)</code></div>
 <div class="col-last even-row-color">
-<div class="block">Creates a Threshold test.</div>
+<div class="block">Creates a threshold test.</div>
 </div>
-<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.function.DoubleSupplier,double,java.util.function.BooleanSupplier)" class="member-name-link">Threshold</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.DoubleSupplier,double,double)" class="member-name-link">ThresholdTest</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a>&nbsp;measurement,
  double&nbsp;threshold,
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a>&nbsp;passCondition)</code></div>
+ double&nbsp;timeOut)</code></div>
 <div class="col-last odd-row-color">
-<div class="block">Creates a current test.</div>
+<div class="block">Creates a threshold test.</div>
 </div>
 </div>
 </section>
@@ -200,33 +215,69 @@ <h3>testName</h3>
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="&lt;init&gt;(java.lang.String,java.util.function.DoubleSupplier,double)">
-<h3>Threshold</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Threshold</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.DoubleSupplier,double,double)">
+<h3>ThresholdTest</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ThresholdTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a>&nbsp;measurement,
- double&nbsp;threshold)</span></div>
-<div class="block">Creates a Threshold test.</div>
+ double&nbsp;threshold,
+ double&nbsp;timeOut)</span></div>
+<div class="block">Creates a threshold test.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>testName</code> - Name of the test.</dd>
+<dd><code>command</code> - Command to run.</dd>
 <dd><code>measurement</code> - Source of measurement.</dd>
 <dd><code>threshold</code> - Threshold that should be reached.</dd>
+<dd><code>timeOut</code> - Time for test to run.</dd>
 </dl>
 </section>
 </li>
 <li>
-<section class="detail" id="&lt;init&gt;(java.lang.String,java.util.function.DoubleSupplier,double,java.util.function.BooleanSupplier)">
-<h3>Threshold</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Threshold</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
- <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a>&nbsp;measurement,
- double&nbsp;threshold,
+<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.BooleanSupplier)">
+<h3>ThresholdTest</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ThresholdTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
+ double&nbsp;timeOut,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a>&nbsp;passCondition)</span></div>
-<div class="block">Creates a current test.</div>
+<div class="block">Creates a threshold test.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>testName</code> - Name of the test.</dd>
+<dd><code>command</code> - Command to run.</dd>
+<dd><code>timeOut</code> - Time for test to run.</dd>
+<dd><code>passCondition</code> - Condition for the test to pass.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.DoubleSupplier,double)">
+<h3>ThresholdTest</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ThresholdTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a>&nbsp;measurement,
+ double&nbsp;threshold)</span></div>
+<div class="block">Creates a threshold test.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>testName</code> - Name of the test.</dd>
+<dd><code>command</code> - Command to run.</dd>
 <dd><code>measurement</code> - Source of measurement.</dd>
 <dd><code>threshold</code> - Threshold that should be reached.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,java.util.function.BooleanSupplier)">
+<h3>ThresholdTest</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ThresholdTest</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;testName,
+ edu.wpi.first.wpilibj2.command.Command&nbsp;command,
+ <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a>&nbsp;passCondition)</span></div>
+<div class="block">Creates a threshold test.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>testName</code> - Name of the test.</dd>
+<dd><code>command</code> - Command to run.</dd>
 <dd><code>passCondition</code> - Condition for the test to pass.</dd>
 </dl>
 </section>