docs/index-files/index-1.html

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Feb 15 00:08:08 CST 2023 -->
<title>A-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-15">
<meta name="description" content="index: A">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/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="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" 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 class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<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">X</a>&nbsp;<a href="index-23.html">Y</a>&nbsp;<a href="index-24.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:A">A</h2>
<dl class="index">
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Whether the absolute encoder is integrated.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Whether the absolute encoder is integrated.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The Absolute Encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Absolute encoder for swerve drive.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Absolute encoder inversion state.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Whether the absolute encoder is inverted.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderOffset" class="member-name-link">absoluteEncoderOffset</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Absolute encoder offset from 0 in degrees.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> with the given timestamp of the vision
 measurement.</div>
</dd>
<dt><a href="../swervelib/math/SwerveModuleState2.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
<dd>
<div class="block">Swerve module angle as a <code>Rotation2d</code>.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Angle motor device configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dd>
<div class="block">Angle motor inversion state.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>
<div class="block">The PIDF with Integral Zone used for the angle motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The current angle of the robot and last time odometry during simulations.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Current state.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleEncoderPulsePerRotation" class="member-name-link">angleEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle motor encoder pulse per rotation.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleGearRatio" class="member-name-link">angleGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle gear ratio.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#angleJoystickRadiusDeadband" class="member-name-link">angleJoystickRadiusDeadband</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">The minimum radius of the angle control joystick to allow for heading adjustment of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband" class="member-name-link">angleJoyStickRadiusDeadband</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">hypotenuse deadband for the robot angle control joystick.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleKV" class="member-name-link">angleKV</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Angle volt-meter-per-second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The drive motor and angle motor of this swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Swerve Motors.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorCurrentLimit" class="member-name-link">angleMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Angle motor free speed rotations per minute.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Free speed rotations per minute of the motor, as described by the vendor.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">State of inversion of the angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorRampRate" class="member-name-link">angleMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Angle offset in degrees for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Angle offset from the absolute encoder.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#anglePIDF" class="member-name-link">anglePIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#applyDeadband(double,boolean,double)" class="member-name-link">applyDeadband(double, boolean, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.CTRE_pidIdx.html#AUXILIARY_PID" class="member-name-link">AUXILIARY_PID</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.CTRE_pidIdx.html" title="enum class in swervelib.motors">TalonSRXSwerve.CTRE_pidIdx</a></dt>
<dd>
<div class="block">Secondary PID for talons.</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">X</a>&nbsp;<a href="index-23.html">Y</a>&nbsp;<a href="index-24.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>