Updated javadocs
This commit is contained in:
@@ -68,7 +68,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Creates chute with mock hardware and custom pot wraparound.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.subsystems.chute.ChuteController,org.firstinspires.ftc.teamcode.subsystems.chute.MockDCMotor,org.firstinspires.ftc.teamcode.subsystems.chute.MockPotentiometer)" class="member-name-link">Chute(ChuteController, MockDCMotor, MockPotentiometer)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.subsystems.chute.ChuteController,org.firstinspires.ftc.teamcode.mock.MockMotor,org.firstinspires.ftc.teamcode.mock.MockPotentiometer)" class="member-name-link">Chute(ChuteController, MockMotor, MockPotentiometer)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates chute with real FTC hardware adapters.</div>
|
||||
</dd>
|
||||
@@ -76,7 +76,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Simple chute controller with homing and position control.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.subsystems.chute.MockDCMotor,org.firstinspires.ftc.teamcode.subsystems.chute.MockPotentiometer,double)" class="member-name-link">ChuteController(MockDCMotor, MockPotentiometer, double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#%3Cinit%3E(org.firstinspires.ftc.teamcode.mock.MockMotor,org.firstinspires.ftc.teamcode.mock.MockPotentiometer,double)" class="member-name-link">ChuteController(MockMotor, MockPotentiometer, double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a new chute controller.</div>
|
||||
</dd>
|
||||
@@ -92,8 +92,6 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Get the home voltage reference captured during homing.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html#getLastCommandedPower()" class="member-name-link">getLastCommandedPower()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockCRServo</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets motor instance for testing.</div>
|
||||
@@ -106,24 +104,14 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Get current position of chute.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#getPot()" class="member-name-link">getPot()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets potentiometer instance for testing.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#getPower()" class="member-name-link">getPower()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html#getSetPowerCallCount()" class="member-name-link">getSetPowerCallCount()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockCRServo</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#getVoltage()" class="member-name-link">getVoltage()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#getWrapAmount()" class="member-name-link">getWrapAmount()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the pot wraparound amount.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#getWrapAmount()" class="member-name-link">getWrapAmount()</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<h2 class="title" id="I:H">H</h2>
|
||||
<dl class="index">
|
||||
@@ -161,30 +149,6 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
<h2 class="title" id="I:M">M</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html" class="type-name-link" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockCRServo</a> - Class in <a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Mock continuous rotation servo for testing.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html#%3Cinit%3E()" class="member-name-link">MockCRServo()</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockCRServo</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" class="type-name-link" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a> - Class in <a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Simple mock motor.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#%3Cinit%3E()" class="member-name-link">MockDCMotor()</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" class="type-name-link" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a> - Class in <a href="org/firstinspires/ftc/teamcode/subsystems/chute/package-summary.html">org.firstinspires.ftc.teamcode.subsystems.chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Simple mock potentiometer with configurable wraparound.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#%3Cinit%3E()" class="member-name-link">MockPotentiometer()</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create potentiometer with default 2pi wraparound.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#%3Cinit%3E(double)" class="member-name-link">MockPotentiometer(double)</a> - Constructor for class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create potentiometer with custom wraparound amount.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html#moveToPosition(double)" class="member-name-link">moveToPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/ChuteController.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">ChuteController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Move to target position.</div>
|
||||
@@ -197,14 +161,6 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
<h2 class="title" id="I:S">S</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html#setPower(double)" class="member-name-link">setPower(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockCRServo.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockCRServo</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#setPower(double)" class="member-name-link">setPower(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#setTargetPosition(double)" class="member-name-link">setTargetPosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">Chute</a></dt>
|
||||
<dd>
|
||||
<div class="block">Commands chute to move to target position.</div>
|
||||
@@ -228,10 +184,6 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Update controller state - call this every loop iteration.</div>
|
||||
</dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html#update(double)" class="member-name-link">update(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockDCMotor.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockDCMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html#updatePosition(double)" class="member-name-link">updatePosition(double)</a> - Method in class org.firstinspires.ftc.teamcode.subsystems.chute.<a href="org/firstinspires/ftc/teamcode/subsystems/chute/MockPotentiometer.html" title="class in org.firstinspires.ftc.teamcode.subsystems.chute">MockPotentiometer</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="org/firstinspires/ftc/teamcode/subsystems/chute/Chute.html#usage-with-real-hardware-heading" class="search-tag-link">Usage with Real Hardware</a> - Search tag in class org.firstinspires.ftc.teamcode.subsystems.chute.Chute</dt>
|
||||
<dd>Section</dd>
|
||||
</dl>
|
||||
|
||||
Reference in New Issue
Block a user