Files
YAGSL/docs/frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html
2023-01-31 10:52:13 -06:00

530 lines
18 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Jan 31 10:51:37 CST 2023 -->
<title>SwerveEncoder</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="SwerveEncoder";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":9,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SwerveEncoder.html">Use</a></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&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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></div>
<h2 title="Class SwerveEncoder" class="title">Class SwerveEncoder&lt;AbsoluteEncoderType&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>frc.robot.subsystems.swervedrive.swerve.SwerveEncoder&lt;AbsoluteEncoderType&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></code>, <code><a href="encoders/PWMAnalogEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMAnalogEncoder</a></code>, <code><a href="encoders/PWMDutyCycleEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMDutyCycleEncoder</a></code>, <code><a href="encoders/REVAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">REVAbsoluteEncoder</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">SwerveEncoder&lt;AbsoluteEncoderType&gt;</span>
extends java.lang.Object</pre>
<div class="block">Swerve Encoder class definition for common interfaces.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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>
<tr class="altColor">
<td class="colFirst"><code><a href="SwerveEncoder.html" title="type parameter in SwerveEncoder">AbsoluteEncoderType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#m_encoder">m_encoder</a></span></code></th>
<td class="colLast">
<div class="block">The encoder can be directly referenced for configuration purposes of onboard PIDs.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SwerveEncoder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure()">configure</a></span>()</code></th>
<td class="colLast">
<div class="block">Configure the absolute encoder if possible.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#factoryDefault()">factoryDefault</a></span>()</code></th>
<td class="colLast">
<div class="block">Reset encoder to factory default settings, if possible.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;AbsoluteEncoderType&gt;<br><a href="SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromEncoder(AbsoluteEncoderType)">fromEncoder</a></span>&#8203;(AbsoluteEncoderType&nbsp;encoder)</code></th>
<td class="colLast">
<div class="block">Get the SwerveEncoder class from the given encoder types</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbsolutePosition()">getAbsolutePosition</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the absolute position in degrees.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract com.ctre.phoenix.sensors.MagnetFieldStrength</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMagnetFieldStrength()">getMagnetFieldStrength</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the magnetic field strength, if available.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVelocity()">getVelocity</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the velocity of the absolute encoder in degrees per second.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reachable()">reachable</a></span>()</code></th>
<td class="colLast">
<div class="block">Is the encoder reachable?</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInverted(boolean)">setInverted</a></span>&#8203;(boolean&nbsp;isInverted)</code></th>
<td class="colLast">
<div class="block">Configure the sensor direction</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOffset(double)">setOffset</a></span>&#8203;(double&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="m_encoder">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m_encoder</h4>
<pre>public&nbsp;<a href="SwerveEncoder.html" title="type parameter in SwerveEncoder">AbsoluteEncoderType</a> m_encoder</pre>
<div class="block">The encoder can be directly referenced for configuration purposes of onboard PIDs.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SwerveEncoder</h4>
<pre>public&nbsp;SwerveEncoder()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="fromEncoder(java.lang.Object)">
<!-- -->
</a><a id="fromEncoder(AbsoluteEncoderType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromEncoder</h4>
<pre class="methodSignature">public static&nbsp;&lt;AbsoluteEncoderType&gt;&nbsp;<a href="SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a>&lt;?&gt;&nbsp;fromEncoder&#8203;(AbsoluteEncoderType&nbsp;encoder)</pre>
<div class="block">Get the SwerveEncoder class from the given encoder types</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>AbsoluteEncoderType</code> - One of DutyCycleEncoder, AnalogEncoder, AbsoluteEncoder, and CANCoder</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encoder</code> - Encoder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SwerveEncoder subclass</dd>
</dl>
</li>
</ul>
<a id="configure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;configure()</pre>
<div class="block">Configure the absolute encoder if possible.</div>
</li>
</ul>
<a id="factoryDefault()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>factoryDefault</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;factoryDefault()</pre>
<div class="block">Reset encoder to factory default settings, if possible.</div>
</li>
</ul>
<a id="getMagnetFieldStrength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMagnetFieldStrength</h4>
<pre class="methodSignature">public abstract&nbsp;com.ctre.phoenix.sensors.MagnetFieldStrength&nbsp;getMagnetFieldStrength()</pre>
<div class="block">Get the magnetic field strength, if available.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CTRE MagneticFieldStrength Enum.</dd>
</dl>
</li>
</ul>
<a id="getAbsolutePosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbsolutePosition</h4>
<pre class="methodSignature">public abstract&nbsp;double&nbsp;getAbsolutePosition()</pre>
<div class="block">Get the absolute position in degrees.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Absolute position (0, 360]</dd>
</dl>
</li>
</ul>
<a id="getVelocity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVelocity</h4>
<pre class="methodSignature">public abstract&nbsp;double&nbsp;getVelocity()</pre>
<div class="block">Get the velocity of the absolute encoder in degrees per second.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Velocity in degrees per second.</dd>
</dl>
</li>
</ul>
<a id="setOffset(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOffset</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;setOffset&#8203;(double&nbsp;offset)</pre>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - Offset in degrees.</dd>
</dl>
</li>
</ul>
<a id="reachable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reachable</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;reachable()</pre>
<div class="block">Is the encoder reachable?</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if reachable, false otherwise.</dd>
</dl>
</li>
</ul>
<a id="setInverted(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setInverted</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;setInverted&#8203;(boolean&nbsp;isInverted)</pre>
<div class="block">Configure the sensor direction</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isInverted</code> - Inverted or not.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/SwerveEncoder.html">Use</a></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&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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>