Skip to content

Commit

Permalink
Changes after testing in workshop 2/6
Browse files Browse the repository at this point in the history
  • Loading branch information
Mason-Lam committed Feb 9, 2024
1 parent ff11fa1 commit 0fc98c9
Show file tree
Hide file tree
Showing 24 changed files with 503 additions and 151 deletions.
20 changes: 13 additions & 7 deletions doc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="block">Motor states when no voltage is applied</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/core/commands/NAR_PIDCommand.html" title="class in common.core.commands">NAR_PIDCommand</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Team 3128's PIDCommand that uses a ControllerBase to control an output.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/core/subsystems/NAR_PIDSubsystem.html" title="class in common.core.subsystems">NAR_PIDSubsystem</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A subsystem based off of <code>PIDSubsystem</code></div>
Expand Down Expand Up @@ -238,16 +240,20 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Team 3128's Tester utility class used to run system checks at competitions.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="common/utility/tester/Tester.TestState.html" title="enum class in common.utility.tester">Tester.TestState</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.Test.html" title="class in common.utility.tester">Tester.Test</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Collection of tests to be run for a system</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="common/utility/tester/Tester.TestState.html" title="enum class in common.utility.tester">Tester.TestState</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum representing test states</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</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/utility/tester/Tester.UnitTest.html" title="class in common.utility.tester">Tester.UnitTest</a></div>
<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 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="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="block">Team 3128's streamlined <code>ProfiledPIDController</code> class.</div>
</div>
</div>
Expand Down
30 changes: 26 additions & 4 deletions doc/common/core/commands/NAR_PIDCommand.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ <h1 title="Class NAR_PIDCommand" class="title">Class NAR_PIDCommand</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">NAR_PIDCommand</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
<div class="block">Team 3128's PIDCommand that uses a ControllerBase to control an output.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2024 Crescendo</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down Expand Up @@ -149,20 +154,23 @@ <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()" class="member-name-link">end</a>()</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-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="#execute()" class="member-name-link">execute</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>void</code></div>
<div class="col-second even-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 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>boolean</code></div>
<div class="col-second odd-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 odd-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-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, end, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isFinished, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, 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 @@ -238,9 +246,23 @@ <h3>execute</h3>
</section>
</li>
<li>
<section class="detail" id="end()">
<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>()</div>
<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>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>end</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</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>isFinished</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</dl>
</section>
</li>
</ul>
Expand Down
4 changes: 3 additions & 1 deletion doc/common/core/commands/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ <h1 title="Package common.core.commands" class="title">Package common.core.comma
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="NAR_PIDCommand.html" title="class in common.core.commands">NAR_PIDCommand</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Team 3128's PIDCommand that uses a ControllerBase to control an output.</div>
</div>
</div>
</div>
</li>
Expand Down
25 changes: 24 additions & 1 deletion doc/common/core/controllers/TrapController.html
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>Field&nbsp;|&nbsp;</li>
<li><a href="#field-detail">Field</a>&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 @@ -95,6 +95,15 @@ <h1 title="Class TrapController" class="title">Class TrapController</h1>
<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 boolean</code></div>
<div class="col-second even-row-color"><code><a href="#shouldLog" class="member-name-link">shouldLog</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-common.core.controllers.ControllerBase">Fields inherited from class&nbsp;common.core.controllers.<a href="ControllerBase.html" title="class in common.core.controllers">ControllerBase</a></h3>
<code><a href="ControllerBase.html#controller">controller</a>, <a href="ControllerBase.html#kA">kA</a>, <a href="ControllerBase.html#kG">kG</a>, <a href="ControllerBase.html#kG_Function">kG_Function</a>, <a href="ControllerBase.html#kS">kS</a>, <a href="ControllerBase.html#kV">kV</a>, <a href="ControllerBase.html#measurement">measurement</a></code></div>
Expand Down Expand Up @@ -208,6 +217,20 @@ <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="shouldLog">
<h3>shouldLog</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">shouldLog</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
Expand Down
8 changes: 4 additions & 4 deletions doc/common/core/subsystems/ElevatorTemplate.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ <h2>Method Summary</h2>
<div class="block">Reset elevator position.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.wpilibj2.command.Command</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setElevator(double)" class="member-name-link">setElevator</a><wbr>(double&nbsp;power)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runElevator(double)" class="member-name-link">runElevator</a><wbr>(double&nbsp;power)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets elevator power.</div>
</div>
Expand Down Expand Up @@ -290,9 +290,9 @@ <h3>moveElevator</h3>
</section>
</li>
<li>
<section class="detail" id="setElevator(double)">
<h3>setElevator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj2.command.Command</span>&nbsp;<span class="element-name">setElevator</span><wbr><span class="parameters">(double&nbsp;power)</span></div>
<section class="detail" id="runElevator(double)">
<h3>runElevator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj2.command.Command</span>&nbsp;<span class="element-name">runElevator</span><wbr><span class="parameters">(double&nbsp;power)</span></div>
<div class="block">Sets elevator power.</div>
<dl class="notes">
<dt>Parameters:</dt>
Expand Down
Loading

0 comments on commit 0fc98c9

Please sign in to comment.