mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-07-03 07:21:40 +00:00
Updated javadocs
This commit is contained in:
thenetworkgrinch
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>SwerveIMUSimulation</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveIMUSimulation (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation, class: SwerveIMUSimulation">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -36,7 +35,7 @@ loadScripts(document, 'script');</script>
|
||||
<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="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -45,13 +44,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li>Field | </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>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -82,33 +81,6 @@ loadScripts(document, 'script');</script>
|
||||
</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>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#angle" class="member-name-link">angle</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Heading of the robot.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#lastTime" class="member-name-link">lastTime</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The last time the timer was read, used to determine position changes.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.Timer</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#timer" class="member-name-link">timer</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Main timer to control movement estimations.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -171,8 +143,7 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Pose2d[] modulePoses,
|
||||
edu.wpi.first.wpilibj.smartdashboard.Field2d field)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update the odometry of the simulated <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>
|
||||
states to the <code>Field2d</code>.</div>
|
||||
<div class="block">Update the odometry of the simulated <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> states to the <code>Field2d</code>.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -186,35 +157,6 @@ loadScripts(document, 'script');</script>
|
||||
</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="timer">
|
||||
<h3>timer</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.Timer</span> <span class="element-name">timer</span></div>
|
||||
<div class="block">Main timer to control movement estimations.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lastTime">
|
||||
<h3>lastTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">lastTime</span></div>
|
||||
<div class="block">The last time the timer was read, used to determine position changes.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="angle">
|
||||
<h3>angle</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">angle</span></div>
|
||||
<div class="block">Heading of the robot.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -283,7 +225,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in m/s/s. If acceleration isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in m/s/s. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>Translation3d</code> of the acceleration as an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a>.</dd>
|
||||
@@ -297,8 +240,7 @@ loadScripts(document, 'script');</script>
|
||||
<a href="../math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[] states,
|
||||
edu.wpi.first.math.geometry.Pose2d[] modulePoses,
|
||||
edu.wpi.first.wpilibj.smartdashboard.Field2d field)</span></div>
|
||||
<div class="block">Update the odometry of the simulated <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>
|
||||
states to the <code>Field2d</code>.</div>
|
||||
<div class="block">Update the odometry of the simulated <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> states to the <code>Field2d</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>kinematics</code> - <a href="../math/SwerveKinematics2.html" title="class in swervelib.math"><code>SwerveKinematics2</code></a> of the swerve drive.</dd>
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>SwerveModuleSimulation</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveModuleSimulation (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation, class: SwerveModuleSimulation">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -36,7 +35,7 @@ loadScripts(document, 'script');</script>
|
||||
<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="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -45,13 +44,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li>Field | </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>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -82,48 +81,6 @@ loadScripts(document, 'script');</script>
|
||||
</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>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#dt" class="member-name-link">dt</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Time delta since last update</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#fakePos" class="member-name-link">fakePos</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Fake motor position.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#fakeSpeed" class="member-name-link">fakeSpeed</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The fake speed of the previous state, used to calculate <a href="#fakePos"><code>fakePos</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#lastTime" class="member-name-link">lastTime</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Last time queried.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private <a href="../math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#state" class="member-name-link">state</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Current simulated swerve module state.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.wpilibj.Timer</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#timer" class="member-name-link">timer</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Main timer to simulate the passage of time.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -177,56 +134,6 @@ loadScripts(document, 'script');</script>
|
||||
</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="timer">
|
||||
<h3>timer</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.Timer</span> <span class="element-name">timer</span></div>
|
||||
<div class="block">Main timer to simulate the passage of time.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="dt">
|
||||
<h3>dt</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">dt</span></div>
|
||||
<div class="block">Time delta since last update</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="fakePos">
|
||||
<h3>fakePos</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">fakePos</span></div>
|
||||
<div class="block">Fake motor position.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="fakeSpeed">
|
||||
<h3>fakeSpeed</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">fakeSpeed</span></div>
|
||||
<div class="block">The fake speed of the previous state, used to calculate <a href="#fakePos"><code>fakePos</code></a>.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lastTime">
|
||||
<h3>lastTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">lastTime</span></div>
|
||||
<div class="block">Last time queried.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="state">
|
||||
<h3>state</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></span> <span class="element-name">state</span></div>
|
||||
<div class="block">Current simulated swerve module state.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -251,8 +158,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="updateStateAndPosition(swervelib.math.SwerveModuleState2)">
|
||||
<h3>updateStateAndPosition</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateStateAndPosition</span><wbr><span class="parameters">(<a href="../math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a> desiredState)</span></div>
|
||||
<div class="block">Update the position and state of the module. Called from <a href="../SwerveModule.html#setDesiredState(swervelib.math.SwerveModuleState2,boolean,boolean)"><code>SwerveModule.setDesiredState(swervelib.math.SwerveModuleState2, boolean, boolean)</code></a> function
|
||||
when simulated.</div>
|
||||
<div class="block">Update the position and state of the module. Called from <a href="../SwerveModule.html#setDesiredState(swervelib.math.SwerveModuleState2,boolean,boolean)"><code>SwerveModule.setDesiredState(swervelib.math.SwerveModuleState2, boolean, boolean)</code></a> function when simulated.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>desiredState</code> - State the swerve module is set to.</dd>
|
||||
|
||||
@@ -1,220 +0,0 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>PhysicsSim.SimProfile</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre, class: PhysicsSim, class: SimProfile">
|
||||
<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.simulation.ctre</a></div>
|
||||
<h1 title="Class PhysicsSim.SimProfile" class="title">Class PhysicsSim.SimProfile</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.simulation.ctre.PhysicsSim.SimProfile</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></code>, <code><a href="TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></code>, <code><a href="VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></code></dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">static class </span><span class="element-name type-name-label">PhysicsSim.SimProfile</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">Holds information about a simulated device.</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>private long</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_lastTime" class="member-name-link">_lastTime</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#_running" class="member-name-link">_running</a></code></div>
|
||||
<div class="col-last odd-row-color"> </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">SimProfile</a>()</code></div>
|
||||
<div class="col-last even-row-color"> </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>protected double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPeriod()" class="member-name-link">getPeriod</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns the time since last call, in milliseconds.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Runs the simulation profile.</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="_lastTime">
|
||||
<h3>_lastTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name">_lastTime</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_running">
|
||||
<h3>_running</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">_running</span></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>SimProfile</h3>
|
||||
<div class="member-signature"><span class="element-name">SimProfile</span>()</div>
|
||||
</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="run()">
|
||||
<h3>run</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div>
|
||||
<div class="block">Runs the simulation profile. Implemented by device-specific profiles.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getPeriod()">
|
||||
<h3>getPeriod</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">double</span> <span class="element-name">getPeriod</span>()</div>
|
||||
<div class="block">Returns the time since last call, in milliseconds.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>PhysicsSim</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>PhysicsSim (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre, class: PhysicsSim">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -36,7 +35,7 @@ loadScripts(document, 'script');</script>
|
||||
<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="../../../index-all.html">Index</a></li>
|
||||
<li><a href="../../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,14 +43,14 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </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>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -82,41 +81,6 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="caption"><span>Nested Classes</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">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>(package private) static class </code></div>
|
||||
<div class="col-second even-row-color"><code><a href="PhysicsSim.SimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Holds information about a simulated device.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== 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>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_simProfiles" class="member-name-link">_simProfiles</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private static <a href="PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#sim" class="member-name-link">sim</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -181,13 +145,6 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Gets the robot simulator instance.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#random(double)" class="member-name-link">random</a><wbr>(double max)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#random(double,double)" class="member-name-link">random</a><wbr>(double min,
|
||||
double max)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
@@ -205,26 +162,6 @@ loadScripts(document, 'script');</script>
|
||||
</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="sim">
|
||||
<h3>sim</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></span> <span class="element-name">sim</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_simProfiles">
|
||||
<h3>_simProfiles</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><<a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a>></span> <span class="element-name">_simProfiles</span></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -256,19 +193,6 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="random(double,double)">
|
||||
<h3>random</h3>
|
||||
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">double</span> <span class="element-name">random</span><wbr><span class="parameters">(double min,
|
||||
double max)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="random(double)">
|
||||
<h3>random</h3>
|
||||
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type">double</span> <span class="element-name">random</span><wbr><span class="parameters">(double max)</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="addTalonSRX(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double)">
|
||||
<h3>addTalonSRX</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addTalonSRX</span><wbr><span class="parameters">(com.ctre.phoenix.motorcontrol.can.TalonSRX talon,
|
||||
|
||||
@@ -1,259 +0,0 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>TalonFXSimProfile</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre, class: TalonFXSimProfile">
|
||||
<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.simulation.ctre</a></div>
|
||||
<h1 title="Class TalonFXSimProfile" class="title">Class TalonFXSimProfile</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"><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">swervelib.simulation.ctre.PhysicsSim.SimProfile</a>
|
||||
<div class="inheritance">swervelib.simulation.ctre.TalonFXSimProfile</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">class </span><span class="element-name type-name-label">TalonFXSimProfile</span>
|
||||
<span class="extends-implements">extends <a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></span></div>
|
||||
<div class="block">Holds information about a simulated TalonFX.</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>private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_accelToFullTime" class="member-name-link">_accelToFullTime</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final com.ctre.phoenix.motorcontrol.can.TalonFX</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#_falcon" class="member-name-link">_falcon</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_fullVel" class="member-name-link">_fullVel</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#_sensorPhase" class="member-name-link">_sensorPhase</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_vel" class="member-name-link">_vel</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current velocity</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(com.ctre.phoenix.motorcontrol.can.TalonFX,double,double,boolean)" class="member-name-link">TalonFXSimProfile</a><wbr>(com.ctre.phoenix.motorcontrol.can.TalonFX falcon,
|
||||
double accelToFullTime,
|
||||
double fullVel,
|
||||
boolean sensorPhase)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new simulation profile for a TalonFX device.</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>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-swervelib.simulation.ctre.PhysicsSim.SimProfile">Methods inherited from class swervelib.simulation.ctre.<a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></h3>
|
||||
<code><a href="PhysicsSim.SimProfile.html#getPeriod()">getPeriod</a></code></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="_falcon">
|
||||
<h3>_falcon</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">com.ctre.phoenix.motorcontrol.can.TalonFX</span> <span class="element-name">_falcon</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_accelToFullTime">
|
||||
<h3>_accelToFullTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">_accelToFullTime</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_fullVel">
|
||||
<h3>_fullVel</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">_fullVel</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_sensorPhase">
|
||||
<h3>_sensorPhase</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">_sensorPhase</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_vel">
|
||||
<h3>_vel</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">_vel</span></div>
|
||||
<div class="block">The current velocity</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>(com.ctre.phoenix.motorcontrol.can.TalonFX,double,double,boolean)">
|
||||
<h3>TalonFXSimProfile</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TalonFXSimProfile</span><wbr><span class="parameters">(com.ctre.phoenix.motorcontrol.can.TalonFX falcon,
|
||||
double accelToFullTime,
|
||||
double fullVel,
|
||||
boolean sensorPhase)</span></div>
|
||||
<div class="block">Creates a new simulation profile for a TalonFX device.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>falcon</code> - The TalonFX device</dd>
|
||||
<dd><code>accelToFullTime</code> - The time the motor takes to accelerate from 0 to full, in seconds</dd>
|
||||
<dd><code>fullVel</code> - The maximum motor velocity, in ticks per 100ms</dd>
|
||||
<dd><code>sensorPhase</code> - The phase of the TalonFX sensors</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="run()">
|
||||
<h3>run</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div>
|
||||
<div class="block">Runs the simulation profile.
|
||||
|
||||
<p>This uses very rudimentary physics simulation and exists to allow users to test features of
|
||||
our products in simulation using our examples out of the box. Users may modify this to utilize more accurate
|
||||
physics simulation.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="PhysicsSim.SimProfile.html#run()">run</a></code> in class <code><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,259 +0,0 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>TalonSRXSimProfile</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre, class: TalonSRXSimProfile">
|
||||
<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.simulation.ctre</a></div>
|
||||
<h1 title="Class TalonSRXSimProfile" class="title">Class TalonSRXSimProfile</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"><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">swervelib.simulation.ctre.PhysicsSim.SimProfile</a>
|
||||
<div class="inheritance">swervelib.simulation.ctre.TalonSRXSimProfile</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">class </span><span class="element-name type-name-label">TalonSRXSimProfile</span>
|
||||
<span class="extends-implements">extends <a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></span></div>
|
||||
<div class="block">Holds information about a simulated TalonSRX.</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>private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_accelToFullTime" class="member-name-link">_accelToFullTime</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#_fullVel" class="member-name-link">_fullVel</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_sensorPhase" class="member-name-link">_sensorPhase</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final com.ctre.phoenix.motorcontrol.can.TalonSRX</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#_talon" class="member-name-link">_talon</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_vel" class="member-name-link">_vel</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current velocity</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(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double,boolean)" class="member-name-link">TalonSRXSimProfile</a><wbr>(com.ctre.phoenix.motorcontrol.can.TalonSRX talon,
|
||||
double accelToFullTime,
|
||||
double fullVel,
|
||||
boolean sensorPhase)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new simulation profile for a TalonSRX device.</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>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-swervelib.simulation.ctre.PhysicsSim.SimProfile">Methods inherited from class swervelib.simulation.ctre.<a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></h3>
|
||||
<code><a href="PhysicsSim.SimProfile.html#getPeriod()">getPeriod</a></code></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="_talon">
|
||||
<h3>_talon</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">com.ctre.phoenix.motorcontrol.can.TalonSRX</span> <span class="element-name">_talon</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_accelToFullTime">
|
||||
<h3>_accelToFullTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">_accelToFullTime</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_fullVel">
|
||||
<h3>_fullVel</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">_fullVel</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_sensorPhase">
|
||||
<h3>_sensorPhase</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">_sensorPhase</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="_vel">
|
||||
<h3>_vel</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">_vel</span></div>
|
||||
<div class="block">The current velocity</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>(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double,boolean)">
|
||||
<h3>TalonSRXSimProfile</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TalonSRXSimProfile</span><wbr><span class="parameters">(com.ctre.phoenix.motorcontrol.can.TalonSRX talon,
|
||||
double accelToFullTime,
|
||||
double fullVel,
|
||||
boolean sensorPhase)</span></div>
|
||||
<div class="block">Creates a new simulation profile for a TalonSRX device.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>talon</code> - The TalonSRX device</dd>
|
||||
<dd><code>accelToFullTime</code> - The time the motor takes to accelerate from 0 to full, in seconds</dd>
|
||||
<dd><code>fullVel</code> - The maximum motor velocity, in ticks per 100ms</dd>
|
||||
<dd><code>sensorPhase</code> - The phase of the TalonSRX sensors</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="run()">
|
||||
<h3>run</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div>
|
||||
<div class="block">Runs the simulation profile.
|
||||
|
||||
<p>This uses very rudimentary physics simulation and exists to allow users to test features of
|
||||
our products in simulation using our examples out of the box. Users may modify this to utilize more accurate
|
||||
physics simulation.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="PhysicsSim.SimProfile.html#run()">run</a></code> in class <code><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,211 +0,0 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>VictorSPXSimProfile</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre, class: VictorSPXSimProfile">
|
||||
<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.simulation.ctre</a></div>
|
||||
<h1 title="Class VictorSPXSimProfile" class="title">Class VictorSPXSimProfile</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"><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">swervelib.simulation.ctre.PhysicsSim.SimProfile</a>
|
||||
<div class="inheritance">swervelib.simulation.ctre.VictorSPXSimProfile</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">class </span><span class="element-name type-name-label">VictorSPXSimProfile</span>
|
||||
<span class="extends-implements">extends <a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></span></div>
|
||||
<div class="block">Holds information about a simulated VictorSPX.</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>final com.ctre.phoenix.motorcontrol.can.VictorSPX</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#_victor" class="member-name-link">_victor</a></code></div>
|
||||
<div class="col-last even-row-color"> </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(com.ctre.phoenix.motorcontrol.can.VictorSPX)" class="member-name-link">VictorSPXSimProfile</a><wbr>(com.ctre.phoenix.motorcontrol.can.VictorSPX victor)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Creates a new simulation profile for a VictorSPX device.</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>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-swervelib.simulation.ctre.PhysicsSim.SimProfile">Methods inherited from class swervelib.simulation.ctre.<a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></h3>
|
||||
<code><a href="PhysicsSim.SimProfile.html#getPeriod()">getPeriod</a></code></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="_victor">
|
||||
<h3>_victor</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">com.ctre.phoenix.motorcontrol.can.VictorSPX</span> <span class="element-name">_victor</span></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>(com.ctre.phoenix.motorcontrol.can.VictorSPX)">
|
||||
<h3>VictorSPXSimProfile</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">VictorSPXSimProfile</span><wbr><span class="parameters">(com.ctre.phoenix.motorcontrol.can.VictorSPX victor)</span></div>
|
||||
<div class="block">Creates a new simulation profile for a VictorSPX device.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>victor</code> - The VictorSPX device</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="run()">
|
||||
<h3>run</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span>()</div>
|
||||
<div class="block">Runs the simulation profile.
|
||||
|
||||
<p>This uses very rudimentary physics simulation and exists to allow users to test features of
|
||||
our products in simulation using our examples out of the box. Users may modify this to utilize more accurate
|
||||
physics simulation.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="PhysicsSim.SimProfile.html#run()">run</a></code> in class <code><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>swervelib.simulation.ctre</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.simulation.ctre (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation.ctre">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -32,7 +31,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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="../../../index-all.html">Index</a></li>
|
||||
<li><a href="../../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -88,22 +87,6 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Manages physics simulation for CTRE products.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Holds information about a simulated device.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Holds information about a simulated TalonFX.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Holds information about a simulated TalonSRX.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Holds information about a simulated VictorSPX.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>swervelib.simulation.ctre Class Hierarchy</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.simulation.ctre Class Hierarchy (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="tree: package: swervelib.simulation.ctre">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -32,7 +31,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../../index-all.html">Index</a></li>
|
||||
<li><a href="../../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -60,13 +59,6 @@ loadScripts(document, 'script');</script>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="PhysicsSim.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="PhysicsSim.SimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a>
|
||||
<ul>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="TalonFXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="TalonSRXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="VictorSPXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>swervelib.simulation</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.simulation (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="declaration: package: swervelib.simulation">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -32,7 +31,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
|
||||
<title>swervelib.simulation Class Hierarchy</title>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.simulation Class Hierarchy (YAGSL-Lib API)</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-04-08">
|
||||
<meta name="description" content="tree: package: swervelib.simulation">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -32,7 +31,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user