Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-27 07:01:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fab24d2fd1e0cfb3cd73fc1787c8bf50d8039e1e
YAGSL/docs/index-files/index-3.html

246 lines
19 KiB
HTML
Raw Normal View History

First commit
2023-01-29 21:03:26 -06:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<!-- Generated by javadoc (11.0.13) on Tue Jan 31 10:51:37 CST 2023 -->
First commit
2023-01-29 21:03:26 -06:00
<title>C-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<meta name="dc.created" content="2023-01-31">
First commit
2023-01-29 21:03:26 -06:00
<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="C-Index";
}
}
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>Package</li>
<li>Class</li>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<li>Use</li>
First commit
2023-01-29 21:03:26 -06:00
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</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="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#checkDirectory(java.io.File)">checkDirectory(File)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Check directory structure.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#checkMain(com.fasterxml.jackson.databind.JsonNode)">checkMain(JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Check the main json for correct attributes.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#checkModule(com.fasterxml.jackson.databind.JsonNode)">checkModule(JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Check module JSON config for existing values.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#close()">close()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Closes this resource, relinquishing any underlying resources.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#close()">close()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Closes this resource, relinquishing any underlying resources.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html#configure()">configure()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html#configure()">configure()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMAnalogEncoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html#configure()">configure()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMDutyCycleEncoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html#configure()">configure()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">REVAbsoluteEncoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html#configure()">configure()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder if possible.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#configurePigeonIMU()">configurePigeonIMU()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Configure the PigeonIMU with factory default settings and a zeroed gyroscope.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#createEncoder(com.fasterxml.jackson.databind.JsonNode)">createEncoder(JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Create SwerveEncoder from JSON config.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#createGyro(com.fasterxml.jackson.databind.JsonNode)">createGyro(JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Create the gyro object based off the configuration.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html#createModule(double,double,double,double,double,double,double,double,boolean,boolean)">createModule(double, double, double, double, double, double, double, double, boolean, boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive.SwerveModuleConfig</a></dt>
<dd>
<div class="block">Create the swerve module from the configuration.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#createModule(com.fasterxml.jackson.databind.JsonNode,java.io.File,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">createModule(JsonNode, File, SwerveModule.SwerveModuleLocation)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Create SwerveModule from JSON configuration file.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#createModules(double,double,double,double,double,double,double,double,boolean,boolean,frc.robot.subsystems.swervedrive.swerve.SwerveDrive.SwerveModuleConfig%5B%5D)">createModules(double, double, double, double, double, double, double, double, boolean, boolean, SwerveDrive.SwerveModuleConfig&lt;?, ?, ?&gt;[])</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Create swerve drive modules</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#createMotor(com.fasterxml.jackson.databind.JsonNode)">createMotor(JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Create the motor controller based off the config.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_pidIdx.html#%3Cinit%3E()">CTRE_pidIdx()</a></span> - Constructor for enum frc.robot.subsystems.swervedrive.swerve.motors.<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></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_remoteSensor.html#%3Cinit%3E()">CTRE_remoteSensor()</a></span> - Constructor for enum frc.robot.subsystems.swervedrive.swerve.motors.<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></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_slotIdx.html#%3Cinit%3E()">CTRE_slotIdx()</a></span> - Constructor for enum frc.robot.subsystems.swervedrive.swerve.motors.<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></dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders"><span class="typeNameLink">CTRECANCoder</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/encoders/package-summary.html">frc.robot.subsystems.swervedrive.swerve.encoders</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html#%3Cinit%3E(com.ctre.phoenix.sensors.CANCoder)">CTRECANCoder(CANCoder)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></dt>
<dd>
<div class="block">Create SwerveEncoder based off CANCoder.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors"><span class="typeNameLink">CTRESwerveMotor</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/motors/package-summary.html">frc.robot.subsystems.swervedrive.swerve.motors</a></dt>
<dd>&nbsp;</dd>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.WPI_TalonFX,frc.robot.subsystems.swervedrive.swerve.SwerveEncoder,frc.robot.subsystems.swervedrive.swerve.SwerveMotor.ModuleMotorType,double,double,double,double)">CTRESwerveMotor(WPI_TalonFX, SwerveEncoder&lt;?&gt;, SwerveMotor.ModuleMotorType, double, double, double, double)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
First commit
2023-01-29 21:03:26 -06:00
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_pidIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors"><span class="typeNameLink">CTRESwerveMotor.CTRE_pidIdx</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/motors/package-summary.html">frc.robot.subsystems.swervedrive.swerve.motors</a></dt>
<dd>
<div class="block">The TalonSRX PID to use onboard.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_remoteSensor.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors"><span class="typeNameLink">CTRESwerveMotor.CTRE_remoteSensor</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/motors/package-summary.html">frc.robot.subsystems.swervedrive.swerve.motors</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.CTRE_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors"><span class="typeNameLink">CTRESwerveMotor.CTRE_slotIdx</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/motors/package-summary.html">frc.robot.subsystems.swervedrive.swerve.motors</a></dt>
<dd>
<div class="block">The Talon SRX Slot profile used to configure the motor to use for the PID.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></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>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<li>Use</li>
First commit
2023-01-29 21:03:26 -06:00
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</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 Copy Permalink