Updated javadocs

This commit is contained in:
thenetworkgrinch
2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions

View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<title>G-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: G">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,10 +53,6 @@ loadScripts(document, 'script');</script>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#gearRatio" class="member-name-link">gearRatio</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Gear ratio for the motors, number of times the motor has to spin before the wheel rotates a single time.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
@@ -289,14 +285,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the position of the swerve module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#getPositionEncoderConversion(boolean)" class="member-name-link">getPositionEncoderConversion(boolean)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Get the encoder conversion for position encoders.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#getPulsePerRotation(int)" class="member-name-link">getPulsePerRotation(int)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Get the encoder pulse per rotation based off of the encoder type.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
@@ -411,11 +399,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the swerve module poses and on the field relative to the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
</dd>