Skip to content

Commit

Permalink
third edits of threshold/plateau
Browse files Browse the repository at this point in the history 
fixed small errors with threshold
edited constructor orders/timeout
added delay parameter to threshold, deleted hasDelayed in plateau
  • Loading branch information
@mliang321cba
mliang321cba committed Jun 5, 2024
1 parent 76bcdb4 commit e7077a3
Show file tree
Hide file tree
Showing 6 changed files with 155 additions and 132 deletions.
61 changes: 19 additions & 42 deletions doc/common/utility/tester/PlateauTest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
Expand Down Expand Up @@ -101,15 +101,6 @@ <h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Comma
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static double</code></div>
<div class="col-second even-row-color"><code><a href="#timeout" class="member-name-link">timeout</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-common.utility.tester.Tester.UnitTest">Fields inherited from class&nbsp;common.utility.tester.<a href="Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></h3>
<code><a href="Tester.UnitTest.html#command">command</a>, <a href="Tester.UnitTest.html#passCondition">passCondition</a>, <a href="Tester.UnitTest.html#testName">testName</a>, <a href="Tester.UnitTest.html#testState">testState</a></code></div>
Expand Down Expand Up @@ -199,34 +190,19 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="timeout">
<h3>timeout</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">timeout</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.DoubleSupplier,double,double)">
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.DoubleSupplier,double)">
<h3>PlateauTest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PlateauTest</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;plateau,
<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;error,
double&nbsp;tolerance,
double&nbsp;timeOut)</span></div>
double&nbsp;tolerance)</span></div>
<div class="block">Creates a plateau test.</div>
<dl class="notes">
<dt>Parameters:</dt>
Expand All @@ -235,62 +211,63 @@ <h3>PlateauTest</h3>
<dd><code>plateau</code> - How long the pass condition must be true for.</dd>
<dd><code>error</code> - Difference from expected value.</dd>
<dd><code>tolerance</code> - Maximum error.</dd>
<dd><code>timeOut</code> - Time to run the test.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,double,java.util.function.BooleanSupplier)">
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.DoubleSupplier,double,double)">
<h3>PlateauTest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PlateauTest</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;plateau,
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 plateau test.</div>
<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;error,
double&nbsp;tolerance,
double&nbsp;timeOut)</span></div>
<div class="block">Creates a plateau test. (specify timeout)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>testName</code> - Name of test.</dd>
<dd><code>command</code> - Command to run.</dd>
<dd><code>plateau</code> - How long the pass condition must be true for.</dd>
<dd><code>error</code> - Difference from expected value.</dd>
<dd><code>tolerance</code> - Maximum error.</dd>
<dd><code>timeOut</code> - Time to run the test.</dd>
<dd><code>passCondition</code> - Condition to pass the test.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.DoubleSupplier,double)">
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,java.util.function.BooleanSupplier)">
<h3>PlateauTest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PlateauTest</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;plateau,
<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;error,
double&nbsp;tolerance)</span></div>
<div class="block">Creates a plateau test.</div>
<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 plateau test. (specify passCondition)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>testName</code> - Name of test.</dd>
<dd><code>command</code> - Command to run.</dd>
<dd><code>plateau</code> - How long the pass condition must be true for.</dd>
<dd><code>error</code> - Difference from expected value.</dd>
<dd><code>tolerance</code> - Maximum error.</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,double,java.util.function.BooleanSupplier)">
<section class="detail" id="&lt;init&gt;(java.lang.String,edu.wpi.first.wpilibj2.command.Command,double,double,java.util.function.BooleanSupplier)">
<h3>PlateauTest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">PlateauTest</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;plateau,
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 plateau test.</div>
<div class="block">Creates a plateau test. (specify passCondition and timeout)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>testName</code> - Name of test.</dd>
<dd><code>command</code> - Command to run.</dd>
<dd><code>plateau</code> - How long the pass condition must be true for.</dd>
<dd><code>passCondition</code> - Condition for the test to pass.</dd>
<dd><code>timeOut</code> - Time to run the test.</dd>
<dd><code>passCondition</code> - Condition to pass the test.</dd>
</dl>
</section>
</li>
Expand Down
Loading

0 comments on commit e7077a3

Please sign in to comment.