Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-19 06:21:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
154bee371a08c7229093ba5300b4b4abf8b3a4ee
YAGSL/docs/allclasses-index.html
thenetworkgrinch 8f28956426 Updated support for Talons
2023-02-13 17:21:24 -06:00

395 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 17:20:01 CST 2023 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.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.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.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":2,"i3":2,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":2,"i13":2,"i14":2,"i15":2,"i16":2,"i17":4,"i18":2,"i19":2,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":4,"i36":4,"i37":4};
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&nbsp;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">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd">&nbsp;</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="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></td>
<th class="colLast" scope="row">
<div class="block">Inverted motor JSON parsed class.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></td>
<th class="colLast" scope="row">
<div class="block">Device JSON parsed class.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></td>
<th class="colLast" scope="row">
<div class="block">Location JSON parsed class.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></td>
<th class="colLast" scope="row">
<div class="block">Used to store doubles for motor configuration.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></td>
<th class="colLast" scope="row">
<div class="block">Used to store ints for motor configuration.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">Communicates with the NavX as the IMU.</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></td>
<th class="colLast" scope="row">
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></td>
<th class="colLast" scope="row">
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></td>
<th class="colLast" scope="row">
<div class="block">SwerveIMU interface for the Pigeon2</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">SwerveIMU interface for the Pigeon.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></td>
<th class="colLast" scope="row">
<div class="block">REV Slots for PID configuration.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></td>
<th class="colLast" scope="row">
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Controller configuration class which is used to configure <a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
</th>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
</th>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
</th>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
</th>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</th>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</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="i26" class="altColor">
<td class="colFirst"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></td>
<th class="colLast" scope="row">
<div class="block">Mathematical functions which pertain to swerve drive.</div>
</th>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></td>
<th class="colLast" scope="row">
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</th>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Module configuration class which is used to configure <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</th>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></td>
<th class="colLast" scope="row">
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</th>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><a href="swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></td>
<th class="colLast" scope="row">
<div class="block">Second order kinematics swerve module state.</div>
</th>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
</th>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></td>
<th class="colLast" scope="row">
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
</th>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></td>
<th class="colLast" scope="row">
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
</th>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></td>
<th class="colLast" scope="row">
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
</th>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><a href="swervelib/motors/TalonSRXSwerve.CTRE_pidIdx.html" title="enum in swervelib.motors">TalonSRXSwerve.CTRE_pidIdx</a></td>
<th class="colLast" scope="row">
<div class="block">The Talon PID to use onboard.</div>
</th>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><a href="swervelib/motors/TalonSRXSwerve.CTRE_remoteSensor.html" title="enum in swervelib.motors">TalonSRXSwerve.CTRE_remoteSensor</a></td>
<th class="colLast" scope="row">
<div class="block">The remote sensor.</div>
</th>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><a href="swervelib/motors/TalonSRXSwerve.CTRE_slotIdx.html" title="enum in swervelib.motors">TalonSRXSwerve.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>
</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&nbsp;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 View Git Blame Copy Permalink