mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
Updated javadocs to reflect changes
This commit is contained in:
thenetworkgrinch
@@ -0,0 +1,298 @@
|
||||
<!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.SwerveModuleLocation</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.SwerveModuleLocation";
|
||||
}
|
||||
}
|
||||
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.SwerveModuleLocation.html" title="enum 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.SwerveModuleLocation" class="title">Uses of Class<br>frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation</h2>
|
||||
</div>
|
||||
<div class="classUseContainer">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<table class="useSummary">
|
||||
<caption><span>Packages that use <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a></code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveDrive.SwerveModuleConfig.</span><code><span class="memberNameLink"><a href="../SwerveDrive.SwerveModuleConfig.html#loc">loc</a></span></code></th>
|
||||
<td class="colLast"> </td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>private <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a></code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveModule.</span><code><span class="memberNameLink"><a href="../SwerveModule.html#swerveLocation">swerveLocation</a></span></code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Enum representing the swerve module's location on the robot, assuming square.</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.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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>static <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a></code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveModule.SwerveModuleLocation.</span><code><span class="memberNameLink"><a href="../SwerveModule.SwerveModuleLocation.html#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<td class="colFirst"><code>static <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a>[]</code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveModule.SwerveModuleLocation.</span><code><span class="memberNameLink"><a href="../SwerveModule.SwerveModuleLocation.html#values()">values</a></span>()</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Returns an array containing the constants of this enum type, in
|
||||
the order they are declared.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="useSummary">
|
||||
<caption><span>Methods in <a href="../package-summary.html">frc.robot.subsystems.swervedrive.swerve</a> with parameters of type <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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>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="rowColor">
|
||||
<td class="colFirst"><code>private edu.wpi.first.math.geometry.Translation2d</code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveModule.</span><code><span class="memberNameLink"><a href="../SwerveModule.html#getSwerveModulePosition(frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">getSwerveModulePosition</a></span>​(<a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a> swerveLocation)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Get the swerve module position in <code>Translation2d</code> from the enum passed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colFirst"><code>static java.lang.String</code></td>
|
||||
<th class="colSecond" scope="row"><span class="typeNameLabel">SwerveModule.</span><code><span class="memberNameLink"><a href="../SwerveModule.html#SwerveModuleLocationToString(frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">SwerveModuleLocationToString</a></span>​(<a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a> swerveLocation)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Convert <a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve"><code>SwerveModule.SwerveModuleLocation</code></a> to <code>String</code> representation.</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.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</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="../SwerveModule.html#%3Cinit%3E(DriveMotorType,AngleMotorType,AbsoluteEncoderType,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation,double,double,double,double,double,double,double,double,double,double,double,boolean,boolean)">SwerveModule</a></span>​(<a href="../SwerveModule.html" title="type parameter in SwerveModule">DriveMotorType</a> mainMotor,
|
||||
<a href="../SwerveModule.html" title="type parameter in SwerveModule">AngleMotorType</a> angleMotor,
|
||||
<a href="../SwerveModule.html" title="type parameter in SwerveModule">AbsoluteEncoderType</a> encoder,
|
||||
<a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a> swervePosition,
|
||||
double driveGearRatio,
|
||||
double steerGearRatio,
|
||||
double steeringOffsetDegrees,
|
||||
double wheelDiameterMeters,
|
||||
double wheelBaseMeters,
|
||||
double driveTrainWidthMeters,
|
||||
double steeringMotorFreeSpeedRPM,
|
||||
double maxSpeedMPS,
|
||||
double maxDriveAcceleration,
|
||||
double drivingPowerLimit,
|
||||
double steeringPowerLimit,
|
||||
boolean steeringInverted,
|
||||
boolean drivingInverted)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Swerve module constructor.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="rowColor">
|
||||
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../SwerveDrive.SwerveModuleConfig.html#%3Cinit%3E(DriveMotorType,SteeringMotorType,AbsoluteEncoder,double,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">SwerveModuleConfig</a></span>​(<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">DriveMotorType</a> driveMotor,
|
||||
<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">SteeringMotorType</a> steerMotor,
|
||||
<a href="../SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">AbsoluteEncoder</a> encoderSteering,
|
||||
double offset,
|
||||
<a href="../SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a> location)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">Swerve Module configuration class to define the motor CAN IDs and absolute encoder offset of a swerve module.</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.SwerveModuleLocation.html" title="enum 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>
|
||||
Reference in New Issue
Block a user