mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
294 lines
14 KiB
HTML
294 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.13) on Tue Jan 31 10:51:37 CST 2023 -->
|
|
<title>Uses of Class frc.robot.subsystems.swervedrive.swerve.SwerveModule</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2023-01-31">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
|
|
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Uses of Class frc.robot.subsystems.swervedrive.swerve.SwerveModule";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var pathtoroot = "../../../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="../package-summary.html">Package</a></li>
|
|
<li><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">Class</a></li>
|
|
<li class="navBarCell1Rev">Use</li>
|
|
<li><a href="../package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<main role="main">
|
|
<div class="header">
|
|
<h2 title="Uses of Class frc.robot.subsystems.swervedrive.swerve.SwerveModule" class="title">Uses of Class<br>frc.robot.subsystems.swervedrive.swerve.SwerveModule</h2>
|
|
</div>
|
|
<div class="classUseContainer">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<table class="useSummary">
|
|
<caption><span>Packages that use <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Package</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colFirst" scope="row"><a href="#frc.robot.subsystems.swervedrive.swerve">frc.robot.subsystems.swervedrive.swerve</a></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
<li class="blockList">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section role="region"><a id="frc.robot.subsystems.swervedrive.swerve">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Uses of <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a> in <a href="../package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></h3>
|
|
<table class="useSummary">
|
|
<caption><span>Fields in <a href="../package-summary.html">frc.robot.subsystems.swervedrive.swerve</a> declared as <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Field</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.</span><code><span class="memberNameLink"><a href="../SwerveDrive.html#m_backLeft">m_backLeft</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">Back left swerve drive</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.</span><code><span class="memberNameLink"><a href="../SwerveDrive.html#m_backRight">m_backRight</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">Back right swerve drive</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.</span><code><span class="memberNameLink"><a href="../SwerveDrive.html#m_frontLeft">m_frontLeft</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">Front left swerve drive</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.</span><code><span class="memberNameLink"><a href="../SwerveDrive.html#m_frontRight">m_frontRight</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">Front right swerve drive</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="useSummary">
|
|
<caption><span>Methods in <a href="../package-summary.html">frc.robot.subsystems.swervedrive.swerve</a> that return <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">DriveMotorType</a>,​<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">SteeringMotorType</a>,​<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">AbsoluteEncoder</a>></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.SwerveModuleConfig.</span><code><span class="memberNameLink"><a href="../SwerveDrive.SwerveModuleConfig.html#createModule(double,double,double,double,double,double,double,double,boolean,boolean)">createModule</a></span>​(double driveGearRatio,
|
|
double steerGearRatio,
|
|
double wheelDiameterMeters,
|
|
double wheelBaseMeters,
|
|
double driveTrainWidthMeters,
|
|
double steeringMotorFreeSpeedRPM,
|
|
double maxSpeedMPS,
|
|
double maxDriveAcceleration,
|
|
boolean steeringInverted,
|
|
boolean drivingInverted)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create the swerve module from the configuration.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>private static <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?></code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveParser.</span><code><span class="memberNameLink"><a href="../SwerveParser.html#createModule(com.fasterxml.jackson.databind.JsonNode,java.io.File,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">createModule</a></span>​(com.fasterxml.jackson.databind.JsonNode mainJson,
|
|
java.io.File moduleFile,
|
|
<a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a> moduleLocation)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create SwerveModule from JSON configuration file.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?>[]</code></td>
|
|
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.</span><code><span class="memberNameLink"><a href="../SwerveDrive.html#createModules(double,double,double,double,double,double,double,double,boolean,boolean,frc.robot.subsystems.swervedrive.swerve.SwerveDrive.SwerveModuleConfig%5B%5D)">createModules</a></span>​(double driveGearRatio,
|
|
double steerGearRatio,
|
|
double wheelDiameterMeters,
|
|
double wheelBaseMeters,
|
|
double driveTrainWidthMeters,
|
|
double steeringMotorFreeSpeedRPM,
|
|
double maxSpeedMPS,
|
|
double maxDriveAcceleration,
|
|
boolean steeringMotorInverted,
|
|
boolean drivingMotorInverted,
|
|
<a href="../SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive.SwerveModuleConfig</a><?,​?,​?>[] configs)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create swerve drive modules</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<table class="useSummary">
|
|
<caption><span>Constructors in <a href="../package-summary.html">frc.robot.subsystems.swervedrive.swerve</a> with parameters of type <a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../SwerveDrive.html#%3Cinit%3E(frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,com.ctre.phoenix.sensors.WPI_Pigeon2,double,double,double,double,double,boolean,edu.wpi.first.math.geometry.Pose2d)">SwerveDrive</a></span>​(<a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?> frontLeft,
|
|
<a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?> frontRight,
|
|
<a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?> backLeft,
|
|
<a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><?,​?,​?> backRight,
|
|
com.ctre.phoenix.sensors.WPI_Pigeon2 pigeon,
|
|
double driverMaxSpeedMetersPerSecond,
|
|
double driverMaxAngularVelocityRadiansPerSecond,
|
|
double driverMaxDriveAccelerationMetersPerSecond,
|
|
double driverMaxAngularAccelerationRadiansPerSecond,
|
|
double physicalMaxSpeedMPS,
|
|
boolean gyroInverted,
|
|
edu.wpi.first.math.geometry.Pose2d start)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Constructor for Swerve Drive assuming modules have been created and configured with PIDF and conversions.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="../package-summary.html">Package</a></li>
|
|
<li><a href="../SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">Class</a></li>
|
|
<li class="navBarCell1Rev">Use</li>
|
|
<li><a href="../package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|