Skip to content

Commit

Permalink
Modify Unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Mason-Lam committed Feb 6, 2024
1 parent a853fb9 commit ff11fa1
Show file tree
Hide file tree
Showing 14 changed files with 744 additions and 217 deletions.
186 changes: 95 additions & 91 deletions doc/allclasses-index.html

Large diffs are not rendered by default.

68 changes: 54 additions & 14 deletions doc/common/core/subsystems/NAR_PIDSubsystem.SetpointTest.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,11 @@ <h1 title="Class NAR_PIDSubsystem.SetpointTest" class="title">Class NAR_PIDSubsy
</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">edu.wpi.first.wpilibj2.command.WaitCommand
<div class="inheritance"><a href="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">common.utility.tester.Tester.UnitTest</a>
<div class="inheritance">common.core.subsystems.NAR_PIDSubsystem.SetpointTest</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
Expand Down Expand Up @@ -110,10 +108,7 @@ <h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Comma
<h2>Field Summary</h2>
<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="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></h3>
<code><a href="../../utility/tester/Tester.UnitTest.html#command">command</a>, <a href="../../utility/tester/Tester.UnitTest.html#passCondition">passCondition</a>, <a href="../../utility/tester/Tester.UnitTest.html#plateau">plateau</a>, <a href="../../utility/tester/Tester.UnitTest.html#testName">testName</a>, <a href="../../utility/tester/Tester.UnitTest.html#testState">testState</a>, <a href="../../utility/tester/Tester.UnitTest.html#timeOut">timeOut</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.WaitCommand">Fields inherited from class&nbsp;edu.wpi.first.wpilibj2.command.WaitCommand</h3>
<code>m_timer</code></div>
<code><a href="../../utility/tester/Tester.UnitTest.html#command">command</a>, <a href="../../utility/tester/Tester.UnitTest.html#passCondition">passCondition</a>, <a href="../../utility/tester/Tester.UnitTest.html#testName">testName</a>, <a href="../../utility/tester/Tester.UnitTest.html#testState">testState</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h3>
<code>m_requirements</code></div>
Expand Down Expand Up @@ -149,20 +144,28 @@ <h2>Method Summary</h2>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</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="#end(boolean)" class="member-name-link">end</a><wbr>(boolean&nbsp;interrupted)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add()" class="member-name-link">add</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add the test to the a Subsystem test</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="#end(boolean)" class="member-name-link">end</a><wbr>(boolean&nbsp;interrupted)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#execute()" class="member-name-link">execute</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#initialize()" class="member-name-link">initialize</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-common.utility.tester.Tester.UnitTest">Methods inherited from class&nbsp;common.utility.tester.<a href="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></h3>
<code><a href="../../utility/tester/Tester.UnitTest.html#execute()">execute</a>, <a href="../../utility/tester/Tester.UnitTest.html#initialize()">initialize</a>, <a href="../../utility/tester/Tester.UnitTest.html#isFinished()">isFinished</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.WaitCommand">Methods inherited from class&nbsp;edu.wpi.first.wpilibj2.command.WaitCommand</h3>
<code>initSendable, runsWhenDisabled</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h3>
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<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">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
Expand Down Expand Up @@ -203,6 +206,26 @@ <h3>SetpointTest</h3>
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="initialize()">
<h3>initialize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">initialize</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../utility/tester/Tester.UnitTest.html#initialize()">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute()">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../utility/tester/Tester.UnitTest.html#execute()">execute</a></code>&nbsp;in class&nbsp;<code><a href="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="end(boolean)">
<h3>end</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">end</span><wbr><span class="parameters">(boolean&nbsp;interrupted)</span></div>
Expand All @@ -212,6 +235,23 @@ <h3>end</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="isFinished()">
<h3>isFinished</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isFinished</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../utility/tester/Tester.UnitTest.html#isFinished()">isFinished</a></code>&nbsp;in class&nbsp;<code><a href="../../utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add()">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">add</span>()</div>
<div class="block">Add the test to the a Subsystem test</div>
</section>
</li>
</ul>
</section>
</li>
Expand Down
4 changes: 0 additions & 4 deletions doc/common/core/subsystems/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,13 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li class="circle">edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)
<ul>
<li class="circle">edu.wpi.first.wpilibj2.command.WaitCommand
<ul>
<li class="circle">common.utility.tester.<a href="../../utility/tester/Tester.UnitTest.html" class="type-name-link" title="class in common.utility.tester">Tester.UnitTest</a>
<ul>
<li class="circle">common.core.subsystems.<a href="NAR_PIDSubsystem.SetpointTest.html" class="type-name-link" title="class in common.core.subsystems">NAR_PIDSubsystem.SetpointTest</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="circle">edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem)
<ul>
<li class="circle">common.core.subsystems.<a href="ManipulatorTemplate.html" class="type-name-link" title="class in common.core.subsystems">ManipulatorTemplate</a></li>
Expand Down
Loading

0 comments on commit ff11fa1

Please sign in to comment.