mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
README updated
This commit is contained in:
thenetworkgrinch
273
docs/allclasses-index.html
Normal file
273
docs/allclasses-index.html
Normal file
@@ -0,0 +1,273 @@
|
||||
<!DOCTYPE HTML>
|
||||
<!-- NewPage -->
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (11.0.13) on Sun Jan 29 15:36:03 CST 2023 -->
|
||||
<title>All Classes</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2023-01-29">
|
||||
<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="All Classes";
|
||||
}
|
||||
}
|
||||
catch(err) {
|
||||
}
|
||||
//-->
|
||||
var data = {"i0":2,"i1":2,"i2":4,"i3":4,"i4":4,"i5":2,"i6":2,"i7":2,"i8":2,"i9":4,"i10":2,"i11":2,"i12":2,"i13":2,"i14":2,"i15":4,"i16":4,"i17":2,"i18":2,"i19":4,"i20":2};
|
||||
var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
|
||||
var altColor = "altColor";
|
||||
var rowColor = "rowColor";
|
||||
var tableTab = "tableTab";
|
||||
var activeTableTab = "activeTableTab";
|
||||
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>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-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">
|
||||
<h1 title="All&nbsp;Classes" class="title">All Classes</h1>
|
||||
</div>
|
||||
<div class="allClassesContainer">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<table class="typeSummary">
|
||||
<caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd"> </span></span></caption>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Class</th>
|
||||
<th class="colLast" scope="col">Description</th>
|
||||
</tr>
|
||||
<tr id="i0" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i1" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i2" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_pidIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor.CTRE_pidIdx</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">The TalonSRX PID to use onboard.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i3" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_remoteSensor.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor.CTRE_remoteSensor</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i4" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor.CTRE_slotIdx</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">The Talon SRX Slot profile used to configure the motor to use for the PID.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i5" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMAnalogEncoder</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i6" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMDutyCycleEncoder</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i7" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">REVAbsoluteEncoder</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i8" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i9" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.REV_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor.REV_slotIdx</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i10" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">SwerveDrive base which is meant to be platform agnostic.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i11" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive.SwerveModuleConfig</a><<a href="frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">DriveMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,​<a href="frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">SteeringMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,​<a href="frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">AbsoluteEncoder</a> extends com.ctre.phoenix.sensors.CANCoder></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Helper class for easier swerve module creation</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i12" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveDriveKinematics2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveDriveKinematics2</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
|
||||
speed.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i13" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a><<a href="frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="type parameter in SwerveEncoder">AbsoluteEncoderType</a>></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Swerve Encoder class definition for common interfaces.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i14" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a><<a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">DriveMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,​<a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">AngleMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,​<a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">AbsoluteEncoderType</a>></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Swerve module for representing a single swerve module of the robot.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i15" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Swerve Module location on the robot.</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i16" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveModule.Verbosity.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.Verbosity</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Verbosity levels for data publishing,</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i17" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveModuleState2</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i18" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></td>
|
||||
<th class="colLast" scope="row"> </th>
|
||||
</tr>
|
||||
<tr id="i19" class="rowColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveMotor.ModuleMotorType.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveMotor.ModuleMotorType</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Motor type for the swerve drive module</div>
|
||||
</th>
|
||||
</tr>
|
||||
<tr id="i20" class="altColor">
|
||||
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></td>
|
||||
<th class="colLast" scope="row">
|
||||
<div class="block">Swerve Drive JSON parser.</div>
|
||||
</th>
|
||||
</tr>
|
||||
</table>
|
||||
</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>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-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