Updated javadocs

2026-06-21 06:31:40 +00:00 · 2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions
--- a/docs/swervelib/parser/SwerveDriveConfiguration.html
+++ b/docs/swervelib/parser/SwerveDriveConfiguration.html
@@ -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>SwerveDriveConfiguration</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="declaration: package: swervelib.parser, class: SwerveDriveConfiguration">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -91,16 +91,6 @@ loadScripts(document, 'script');</script>
 <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>double</code></div>
-<div class="col-second even-row-color"><code><a href="#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a></code></div>
-<div class="col-last even-row-color">
-<div class="block">Max module speed in meters per second.</div>
-</div>
-<div class="col-first odd-row-color"><code>double</code></div>
-<div class="col-second odd-row-color"><code><a href="#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a></code></div>
-<div class="col-last odd-row-color">
-<div class="block">Max module speed in meters per second.</div>
-</div>
 <div class="col-first even-row-color"><code><a href="../imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></div>
 <div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
 <div class="col-last even-row-color">
@@ -111,26 +101,26 @@ loadScripts(document, 'script');</script>
 <div class="col-last odd-row-color">
 <div class="block">Invert the imu measurements.</div>
 </div>
-<div class="col-first even-row-color"><code>double</code></div>
-<div class="col-second even-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
+<div class="col-first even-row-color"><code>int</code></div>
+<div class="col-second even-row-color"><code><a href="#moduleCount" class="member-name-link">moduleCount</a></code></div>
 <div class="col-last even-row-color">
-<div class="block">Max module speed in meters per second.</div>
-</div>
-<div class="col-first odd-row-color"><code>int</code></div>
-<div class="col-second odd-row-color"><code><a href="#moduleCount" class="member-name-link">moduleCount</a></code></div>
-<div class="col-last odd-row-color">
 <div class="block">Number of modules on the robot.</div>
 </div>
-<div class="col-first even-row-color"><code>edu.wpi.first.math.geometry.Translation2d[]</code></div>
-<div class="col-second even-row-color"><code><a href="#moduleLocationsMeters" class="member-name-link">moduleLocationsMeters</a></code></div>
-<div class="col-last even-row-color">
+<div class="col-first odd-row-color"><code>edu.wpi.first.math.geometry.Translation2d[]</code></div>
+<div class="col-second odd-row-color"><code><a href="#moduleLocationsMeters" class="member-name-link">moduleLocationsMeters</a></code></div>
+<div class="col-last odd-row-color">
 <div class="block">Swerve Module locations.</div>
 </div>
-<div class="col-first odd-row-color"><code><a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
-<div class="col-second odd-row-color"><code><a href="#modules" class="member-name-link">modules</a></code></div>
-<div class="col-last odd-row-color">
+<div class="col-first even-row-color"><code><a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
+<div class="col-second even-row-color"><code><a href="#modules" class="member-name-link">modules</a></code></div>
+<div class="col-last even-row-color">
 <div class="block">Swerve Modules.</div>
 </div>
+<div class="col-first odd-row-color"><code><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block">Physical characteristics of the swerve drive from physicalproperties.json.</div>
+</div>
 </div>
 </section>
 </li>
@@ -142,10 +132,11 @@ loadScripts(document, 'script');</script>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
-<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,double,boolean)" class="member-name-link">SwerveDriveConfiguration</a><wbr>(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;moduleConfigs,
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,boolean,edu.wpi.first.math.controller.SimpleMotorFeedforward,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">SwerveDriveConfiguration</a><wbr>(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;moduleConfigs,
 <a href="../imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a>&nbsp;swerveIMU,
- double&nbsp;maxSpeed,
- boolean&nbsp;invertedIMU)</code></div>
+ boolean&nbsp;invertedIMU,
+ edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ <a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Create swerve drive configuration.</div>
 </div>
@@ -164,7 +155,8 @@ loadScripts(document, 'script');</script>
 <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><a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D)" class="member-name-link">createModules</a><wbr>(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;swerves)</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">createModules</a><wbr>(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;swerves,
+ edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Create modules based off of the SwerveModuleConfiguration.</div>
 </div>
@@ -207,27 +199,6 @@ loadScripts(document, 'script');</script>
 </section>
 </li>
 <li>
-<section class="detail" id="maxSpeed">
-<h3>maxSpeed</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">maxSpeed</span></div>
-<div class="block">Max module speed in meters per second.</div>
-</section>
-</li>
-<li>
-<section class="detail" id="attainableMaxTranslationalSpeedMetersPerSecond">
-<h3>attainableMaxTranslationalSpeedMetersPerSecond</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">attainableMaxTranslationalSpeedMetersPerSecond</span></div>
-<div class="block">Max module speed in meters per second.</div>
-</section>
-</li>
-<li>
-<section class="detail" id="attainableMaxRotationalVelocityRadiansPerSecond">
-<h3>attainableMaxRotationalVelocityRadiansPerSecond</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">attainableMaxRotationalVelocityRadiansPerSecond</span></div>
-<div class="block">Max module speed in meters per second.</div>
-</section>
-</li>
-<li>
 <section class="detail" id="moduleCount">
 <h3>moduleCount</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">moduleCount</span></div>
@@ -241,6 +212,13 @@ loadScripts(document, 'script');</script>
 <div class="block">Swerve Modules.</div>
 </section>
 </li>
+<li>
+<section class="detail" id="physicalCharacteristics">
+<h3>physicalCharacteristics</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></span>&nbsp;<span class="element-name">physicalCharacteristics</span></div>
+<div class="block">Physical characteristics of the swerve drive from physicalproperties.json.</div>
+</section>
+</li>
 </ul>
 </section>
 </li>
@@ -250,19 +228,20 @@ loadScripts(document, 'script');</script>
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="&lt;init&gt;(swervelib.parser.SwerveModuleConfiguration[],swervelib.imu.SwerveIMU,double,boolean)">
+<section class="detail" id="&lt;init&gt;(swervelib.parser.SwerveModuleConfiguration[],swervelib.imu.SwerveIMU,boolean,edu.wpi.first.math.controller.SimpleMotorFeedforward,swervelib.parser.SwerveModulePhysicalCharacteristics)">
 <h3>SwerveDriveConfiguration</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveDriveConfiguration</span><wbr><span class="parameters">(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;moduleConfigs,
 <a href="../imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a>&nbsp;swerveIMU,
- double&nbsp;maxSpeed,
- boolean&nbsp;invertedIMU)</span></div>
+ boolean&nbsp;invertedIMU,
+ edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ <a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics)</span></div>
 <div class="block">Create swerve drive configuration.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>moduleConfigs</code> - Module configuration.</dd>
 <dd><code>swerveIMU</code> - Swerve IMU.</dd>
-<dd><code>maxSpeed</code> - Max speed of the robot in meters per second.</dd>
 <dd><code>invertedIMU</code> - Invert the IMU.</dd>
+<dd><code>driveFeedforward</code> - The drive motor feedforward to use for the <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</dd>
 </dl>
 </section>
 </li>
@@ -275,13 +254,16 @@ loadScripts(document, 'script');</script>
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="createModules(swervelib.parser.SwerveModuleConfiguration[])">
+<section class="detail" id="createModules(swervelib.parser.SwerveModuleConfiguration[],edu.wpi.first.math.controller.SimpleMotorFeedforward)">
 <h3>createModules</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</span>&nbsp;<span class="element-name">createModules</span><wbr><span class="parameters">(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;swerves)</span></div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</span>&nbsp;<span class="element-name">createModules</span><wbr><span class="parameters">(<a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a>[]&nbsp;swerves,
+ edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward)</span></div>
 <div class="block">Create modules based off of the SwerveModuleConfiguration.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>swerves</code> - Swerve constants.</dd>
+<dd><code>driveFeedforward</code> - Drive feedforward created using
+                         <a href="../math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
 <dt>Returns:</dt>
 <dd>Swerve Modules.</dd>
 </dl>