Skip to content

Commit

Permalink
fixed javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sam-Belliveau
Sam-Belliveau committed Jan 31, 2020
1 parent 0990abb commit 9a34af8
Show file tree
Hide file tree
Showing 21 changed files with 863 additions and 90 deletions.
37 changes: 24 additions & 13 deletions docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":1,"i1":2,"i2":2,"i3":8,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":4,"i11":2,"i12":2,"i13":2,"i14":1,"i15":2,"i16":1,"i17":1,"i18":2,"i19":2,"i20":4,"i21":4,"i22":4,"i23":4,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":2,"i36":2,"i37":2,"i38":2,"i39":2,"i40":2,"i41":2,"i42":2,"i43":2,"i44":2,"i45":2,"i46":2,"i47":2};
var data = {"i0":1,"i1":2,"i2":2,"i3":8,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":4,"i11":2,"i12":2,"i13":2,"i14":1,"i15":2,"i16":1,"i17":1,"i18":2,"i19":2,"i20":4,"i21":4,"i22":4,"i23":4,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":2,"i36":2,"i37":2,"i38":2,"i39":2,"i40":2,"i41":2,"i42":2,"i43":2,"i44":2,"i45":2,"i46":2,"i47":2,"i48":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -210,7 +210,9 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/file/FRCLogger.Loggable.html" title="interface in com.stuypulse.stuylib.file">FRCLogger.Loggable</a></td>
<th class="colLast" scope="row">
<div class="block">Implementable interface with getLog() function.</div>
<div class="block">The Loggable interface should be implemented by a class that can
return a useful piece of data that can be called on demand to be written
into the log.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
Expand Down Expand Up @@ -350,19 +352,28 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</th>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html" title="class in com.stuypulse.stuylib.streams.filters">OrderedRollingAverage</a></td>
<th class="colLast" scope="row">
<div class="block">Simple implementation of an Exponential Moving Average

This is not time dependant, so the values will change if you change the rate
that you call this filter, the filter will not adapt for that.</div>
</th>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/control/PIDCalculator.html" title="class in com.stuypulse.stuylib.control">PIDCalculator</a></td>
<th class="colLast" scope="row">
<div class="block">This is a Bang-Bang controller that while controlling the robot, will be able
to calculate the values for the PID controller.</div>
</th>
</tr>
<tr id="i37" class="rowColor">
<tr id="i38" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/control/PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></td>
<th class="colLast" scope="row">
<div class="block">This PID controller is built by extending the Controller class.</div>
</th>
</tr>
<tr id="i38" class="altColor">
<tr id="i39" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/streams/PollingIStream.html" title="class in com.stuypulse.stuylib.streams">PollingIStream</a></td>
<th class="colLast" scope="row">
<div class="block">Takes an IStream and an IStreamFilter and makes a PollingIStream
Expand All @@ -371,13 +382,13 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
calls get</div>
</th>
</tr>
<tr id="i39" class="rowColor">
<tr id="i40" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/input/gamepads/PS4.html" title="class in com.stuypulse.stuylib.input.gamepads">PS4</a></td>
<th class="colLast" scope="row">
<div class="block">Implementation of the PS4 for the Gamepad Class</div>
</th>
</tr>
<tr id="i40" class="altColor">
<tr id="i41" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/streams/filters/RateLimit.html" title="class in com.stuypulse.stuylib.streams.filters">RateLimit</a></td>
<th class="colLast" scope="row">
<div class="block">This class lets you rate limit a stream of inputs
Expand All @@ -389,7 +400,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
that you call this filter, the filter will not adapt for that.</div>
</th>
</tr>
<tr id="i41" class="rowColor">
<tr id="i42" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/streams/filters/RollingAverage.html" title="class in com.stuypulse.stuylib.streams.filters">RollingAverage</a></td>
<th class="colLast" scope="row">
<div class="block">Simple implementation of an Exponential Moving Average
Expand All @@ -398,40 +409,40 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
that you call this filter, the filter will not adapt for that.</div>
</th>
</tr>
<tr id="i42" class="altColor">
<tr id="i43" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/math/SLMath.html" title="class in com.stuypulse.stuylib.math">SLMath</a></td>
<th class="colLast" scope="row">
<div class="block">SLMath (StuyLib Math) is a class containing many algorithms that are useful
for developing robot code.</div>
</th>
</tr>
<tr id="i43" class="rowColor">
<tr id="i44" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/network/SLNetworkTable.html" title="class in com.stuypulse.stuylib.network">SLNetworkTable</a></td>
<th class="colLast" scope="row">
<div class="block">The SLNetworkTable is a very fast way to easily interface with a network
table.</div>
</th>
</tr>
<tr id="i44" class="altColor">
<tr id="i45" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/network/limelight/Solve3DResult.html" title="class in com.stuypulse.stuylib.network.limelight">Solve3DResult</a></td>
<th class="colLast" scope="row">
<div class="block">Class that is used to return solve 3D results from the limelight</div>
</th>
</tr>
<tr id="i45" class="rowColor">
<tr id="i46" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/util/StopWatch.html" title="class in com.stuypulse.stuylib.util">StopWatch</a></td>
<th class="colLast" scope="row">
<div class="block">This StopWatch class helps classes who want their functions to be time
independant do that by giving them an easy way to get intervals of time.</div>
</th>
</tr>
<tr id="i46" class="altColor">
<tr id="i47" class="rowColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/math/Vector2D.html" title="class in com.stuypulse.stuylib.math">Vector2D</a></td>
<th class="colLast" scope="row">
<div class="block">Simple coordinate class that defines many helpful functions like</div>
</th>
</tr>
<tr id="i47" class="rowColor">
<tr id="i48" class="altColor">
<td class="colFirst"><a href="com/stuypulse/stuylib/input/WPIGamepad.html" title="class in com.stuypulse.stuylib.input">WPIGamepad</a></td>
<th class="colLast" scope="row">
<div class="block">WPI Gamepad extends Gamepad and adds functions that makes interacting with
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/stuypulse/stuylib/input/buttons/NewButton.html" title="class in com.stuypulse.stuylib.input.buttons">NewButton</a></li>
<li><a href="com/stuypulse/stuylib/input/buttons/OldButton.html" title="class in com.stuypulse.stuylib.input.buttons">OldButton</a></li>
<li><a href="com/stuypulse/stuylib/streams/filters/OnDerivative.html" title="class in com.stuypulse.stuylib.streams.filters">OnDerivative</a></li>
<li><a href="com/stuypulse/stuylib/streams/filters/OrderedRollingAverage.html" title="class in com.stuypulse.stuylib.streams.filters">OrderedRollingAverage</a></li>
<li><a href="com/stuypulse/stuylib/control/PIDCalculator.html" title="class in com.stuypulse.stuylib.control">PIDCalculator</a></li>
<li><a href="com/stuypulse/stuylib/control/PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></li>
<li><a href="com/stuypulse/stuylib/streams/PollingIStream.html" title="class in com.stuypulse.stuylib.streams">PollingIStream</a></li>
Expand Down
39 changes: 31 additions & 8 deletions docs/com/stuypulse/stuylib/control/Controller.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var data = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -220,37 +220,45 @@ <h3>Method Summary</h3>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVelocity()">getVelocity</a></span>()</code></th>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRawVelocity()">getRawVelocity</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the velocity, which is represented as the change in error, from the last
<div class="block">Gets the velocity, which is represented as the change in error since the last
time that .update() was called</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVelocity()">getVelocity</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the velocity from the last time that .update() was called adjusted to
velocity per second</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Controller.html" title="class in com.stuypulse.stuylib.control">Controller</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setErrorFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setErrorFilter</a></span>&#8203;(<a href="../streams/filters/IStreamFilter.html" title="interface in com.stuypulse.stuylib.streams.filters">IStreamFilter</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Lets you specify a filter that will be applied to all measurements that are
given to the controller.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Controller.html" title="class in com.stuypulse.stuylib.control">Controller</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutputFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setOutputFilter</a></span>&#8203;(<a href="../streams/filters/IStreamFilter.html" title="interface in com.stuypulse.stuylib.streams.filters">IStreamFilter</a>&nbsp;filter)</code></th>
<td class="colLast">
<div class="block">Lets you specify a filter that will be applied to all of the outputs of the
controller.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update(double)">update</a></span>&#8203;(double&nbsp;error)</code></th>
<td class="colLast">
<div class="block">Update the controller with the error from the destination that you want to
reach</div>
</td>
</tr>
<tr id="i8" class="altColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update(double,double)">update</a></span>&#8203;(double&nbsp;measurement,
double&nbsp;setpoint)</code></th>
Expand Down Expand Up @@ -374,15 +382,30 @@ <h4>getError</h4>
</dl>
</li>
</ul>
<a id="getRawVelocity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawVelocity</h4>
<pre class="methodSignature">public final&nbsp;double&nbsp;getRawVelocity()</pre>
<div class="block">Gets the velocity, which is represented as the change in error since the last
time that .update() was called</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>velocity from the last time that .update() was called</dd>
</dl>
</li>
</ul>
<a id="getVelocity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVelocity</h4>
<pre class="methodSignature">public final&nbsp;double&nbsp;getVelocity()</pre>
<div class="block">Gets the velocity, which is represented as the change in error, from the last
time that .update() was called</div>
<div class="block">Gets the velocity from the last time that .update() was called adjusted to
velocity per second</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>velocity from the last time that .update() was called</dd>
Expand Down
78 changes: 70 additions & 8 deletions docs/com/stuypulse/stuylib/control/PIDCalculator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -192,46 +192,65 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getK()">getK</a></span>()</code></th>
<td class="colLast">
<div class="block">Adjusted Amplitude of Oscillations</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPController()">getPController</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPIController()">getPIController</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPIDController()">getPIDController</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPIDController(double,double,double)">getPIDController</a></span>&#8203;(double&nbsp;kP,
double&nbsp;kI,
double&nbsp;kD)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getT()">getT</a></span>()</code></th>
<td class="colLast">
<div class="block">Period of Oscillations</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="PIDCalculator.html" title="class in com.stuypulse.stuylib.control">PIDCalculator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setControlSpeed(double)">setControlSpeed</a></span>&#8203;(double&nbsp;speed)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.stuypulse.stuylib.control.Controller">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.stuypulse.stuylib.control.<a href="Controller.html" title="class in com.stuypulse.stuylib.control">Controller</a></h3>
<code><a href="Controller.html#getError()">getError</a>, <a href="Controller.html#getOutput()">getOutput</a>, <a href="Controller.html#getRate()">getRate</a>, <a href="Controller.html#getVelocity()">getVelocity</a>, <a href="Controller.html#setErrorFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setErrorFilter</a>, <a href="Controller.html#setOutputFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setOutputFilter</a>, <a href="Controller.html#update(double)">update</a>, <a href="Controller.html#update(double,double)">update</a></code></li>
<code><a href="Controller.html#getError()">getError</a>, <a href="Controller.html#getOutput()">getOutput</a>, <a href="Controller.html#getRate()">getRate</a>, <a href="Controller.html#getRawVelocity()">getRawVelocity</a>, <a href="Controller.html#getVelocity()">getVelocity</a>, <a href="Controller.html#setErrorFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setErrorFilter</a>, <a href="Controller.html#setOutputFilter(com.stuypulse.stuylib.streams.filters.IStreamFilter)">setOutputFilter</a>, <a href="Controller.html#update(double)">update</a>, <a href="Controller.html#update(double,double)">update</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -306,6 +325,34 @@ <h4>calculate</h4>
</dl>
</li>
</ul>
<a id="getK()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getK</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getK()</pre>
<div class="block">Adjusted Amplitude of Oscillations</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get calculated K value for PID value equation</dd>
</dl>
</li>
</ul>
<a id="getT()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getT</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getT()</pre>
<div class="block">Period of Oscillations</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Get calculated T value for PID value equation</dd>
</dl>
</li>
</ul>
<a id="getPIDController(double,double,double)">
<!-- -->
</a>
Expand Down Expand Up @@ -354,7 +401,7 @@ <h4>getPIController</h4>
<a id="getPController()">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>getPController</h4>
<pre class="methodSignature">public&nbsp;<a href="PIDController.html" title="class in com.stuypulse.stuylib.control">PIDController</a>&nbsp;getPController()</pre>
Expand All @@ -364,6 +411,21 @@ <h4>getPController</h4>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>information about this PIDController</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
Expand Down
Loading

0 comments on commit 9a34af8

Please sign in to comment.