mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
364 lines
18 KiB
HTML
364 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Wed Feb 22 20:48:44 CST 2023 -->
|
|
<title>PIDFConfig</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-22">
|
|
<meta name="description" content="declaration: package: swervelib.parser, class: PIDFConfig">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<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="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
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><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field-summary">Field</a> | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field-detail">Field</a> | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<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">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.parser</a></div>
|
|
<h1 title="Class PIDFConfig" class="title">Class PIDFConfig</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">swervelib.parser.PIDFConfig</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PIDFConfig</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>double</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#d" class="member-name-link">d</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Derivative Gain for PID.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>double</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#f" class="member-name-link">f</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Feedforward value for PID.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>double</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#fscalar" class="member-name-link">fscalar</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Feedforward scalar for PID applied dynamically.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code>double</code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#i" class="member-name-link">i</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Integral Gain for PID.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>double</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#iz" class="member-name-link">iz</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Integral zone of the PID.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></code></div>
|
|
<div class="col-second odd-row-color"><code><a href="#output" class="member-name-link">output</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">The PIDF output range.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code>double</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#p" class="member-name-link">p</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Proportional Gain for PID.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">PIDFConfig</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Used when parsing PIDF values from JSON.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double)" class="member-name-link">PIDFConfig</a><wbr>(double p,
|
|
double d)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double,double,double)" class="member-name-link">PIDFConfig</a><wbr>(double p,
|
|
double i,
|
|
double d)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double,double,double)" class="member-name-link">PIDFConfig</a><wbr>(double p,
|
|
double i,
|
|
double d,
|
|
double f)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double,double,double,double,double)" class="member-name-link">PIDFConfig</a><wbr>(double p,
|
|
double i,
|
|
double d,
|
|
double f,
|
|
double iz)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.controller.PIDController</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createPIDController()" class="member-name-link">createPIDController</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Create a PIDController from the PID values.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="p">
|
|
<h3>p</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">p</span></div>
|
|
<div class="block">Proportional Gain for PID.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="i">
|
|
<h3>i</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">i</span></div>
|
|
<div class="block">Integral Gain for PID.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="d">
|
|
<h3>d</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">d</span></div>
|
|
<div class="block">Derivative Gain for PID.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="f">
|
|
<h3>f</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">f</span></div>
|
|
<div class="block">Feedforward value for PID.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="fscalar">
|
|
<h3>fscalar</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">fscalar</span></div>
|
|
<div class="block">Feedforward scalar for PID applied dynamically.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="iz">
|
|
<h3>iz</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">iz</span></div>
|
|
<div class="block">Integral zone of the PID.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="output">
|
|
<h3>output</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></span> <span class="element-name">output</span></div>
|
|
<div class="block">The PIDF output range.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>PIDFConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PIDFConfig</span>()</div>
|
|
<div class="block">Used when parsing PIDF values from JSON.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(double,double,double,double,double)">
|
|
<h3>PIDFConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PIDFConfig</span><wbr><span class="parameters">(double p,
|
|
double i,
|
|
double d,
|
|
double f,
|
|
double iz)</span></div>
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>p</code> - P gain.</dd>
|
|
<dd><code>i</code> - I gain.</dd>
|
|
<dd><code>d</code> - D gain.</dd>
|
|
<dd><code>f</code> - F gain.</dd>
|
|
<dd><code>iz</code> - Intergral zone.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(double,double,double,double)">
|
|
<h3>PIDFConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PIDFConfig</span><wbr><span class="parameters">(double p,
|
|
double i,
|
|
double d,
|
|
double f)</span></div>
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>p</code> - P gain.</dd>
|
|
<dd><code>i</code> - I gain.</dd>
|
|
<dd><code>d</code> - D gain.</dd>
|
|
<dd><code>f</code> - F gain.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(double,double,double)">
|
|
<h3>PIDFConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PIDFConfig</span><wbr><span class="parameters">(double p,
|
|
double i,
|
|
double d)</span></div>
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>p</code> - P gain.</dd>
|
|
<dd><code>i</code> - I gain.</dd>
|
|
<dd><code>d</code> - D gain.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(double,double)">
|
|
<h3>PIDFConfig</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PIDFConfig</span><wbr><span class="parameters">(double p,
|
|
double d)</span></div>
|
|
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>p</code> - P gain.</dd>
|
|
<dd><code>d</code> - D gain.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="createPIDController()">
|
|
<h3>createPIDController</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.controller.PIDController</span> <span class="element-name">createPIDController</span>()</div>
|
|
<div class="block">Create a PIDController from the PID values.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>PIDController.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|