Files
YAGSL/docs/frc/robot/Constants.html

217 lines
11 KiB
HTML
Raw Normal View History

2023-08-29 19:59:07 -05:00
<!DOCTYPE HTML>
<html lang="en">
<head>
2024-01-15 14:37:13 -06:00
<!-- Generated by javadoc (17) -->
<title>Constants (YAGSL-Example API)</title>
2023-08-29 19:59:07 -05:00
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2024-01-15 14:37:13 -06:00
<meta name="description" content="declaration: package: frc.robot, class: Constants">
2023-08-29 19:59:07 -05:00
<meta name="generator" content="javadoc/ClassWriterImpl">
2024-01-15 14:37:13 -06:00
<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.6.0.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
2023-08-29 19:59:07 -05:00
</head>
<body class="class-declaration-page">
2024-01-15 14:37:13 -06:00
<script type="text/javascript">var pathtoroot = "../../";
2023-08-29 19:59:07 -05:00
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">
2024-01-15 14:37:13 -06:00
<li><a href="../../index.html">Overview</a></li>
2023-08-29 19:59:07 -05:00
<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>
2024-01-15 14:37:13 -06:00
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li>
2023-08-29 19:59:07 -05:00
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
2024-01-15 14:37:13 -06:00
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
2023-08-29 19:59:07 -05:00
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
2024-01-15 14:37:13 -06:00
<li>Method</li>
2023-08-29 19:59:07 -05:00
</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">
2024-01-15 14:37:13 -06:00
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">frc.robot</a></div>
<h1 title="Class Constants" class="title">Class Constants</h1>
2023-08-29 19:59:07 -05:00
</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>
2024-01-15 14:37:13 -06:00
<div class="inheritance">frc.robot.Constants</div>
2023-08-29 19:59:07 -05:00
</div>
<section class="class-description" id="class-description">
<hr>
2024-01-15 14:37:13 -06:00
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Constants</span>
2023-08-29 19:59:07 -05:00
<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>
2024-01-15 14:37:13 -06:00
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean constants. This
class should not be used for any other purpose. All constants should be declared globally (i.e. public static). Do
not put anything functional in this class.
<p>It is advised to statically import this class (or one of its inner classes) wherever the
constants are needed, to reduce verbosity.</div>
2023-08-29 19:59:07 -05:00
</section>
<section class="summary">
<ul class="summary-list">
2024-01-15 14:37:13 -06:00
<!-- ======== 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>static final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.Auton.html" class="type-name-link" title="class in frc.robot">Constants.Auton</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Drivebase.html" class="type-name-link" title="class in frc.robot">Constants.Drivebase</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.OperatorConstants.html" class="type-name-link" title="class in frc.robot">Constants.OperatorConstants</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
2023-08-29 19:59:07 -05:00
<!-- =========== 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>
2024-01-15 14:37:13 -06:00
<div class="col-first even-row-color"><code>static final <a href="../../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></code></div>
<div class="col-second even-row-color"><code><a href="#CHASSIS" class="member-name-link">CHASSIS</a></code></div>
2023-08-29 19:59:07 -05:00
<div class="col-last even-row-color">&nbsp;</div>
2024-01-15 14:37:13 -06:00
<div class="col-first odd-row-color"><code>static final double</code></div>
<div class="col-second odd-row-color"><code><a href="#LOOP_TIME" class="member-name-link">LOOP_TIME</a></code></div>
2023-08-29 19:59:07 -05:00
<div class="col-last odd-row-color">&nbsp;</div>
2024-01-15 14:37:13 -06:00
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#ROBOT_MASS" class="member-name-link">ROBOT_MASS</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
2023-08-29 19:59:07 -05:00
</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>
2024-01-15 14:37:13 -06:00
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Constants</a>()</code></div>
2023-08-29 19:59:07 -05:00
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
2024-01-15 14:37:13 -06:00
<section class="detail" id="ROBOT_MASS">
<h3>ROBOT_MASS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">ROBOT_MASS</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.ROBOT_MASS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
2023-08-29 19:59:07 -05:00
</section>
</li>
<li>
2024-01-15 14:37:13 -06:00
<section class="detail" id="CHASSIS">
<h3>CHASSIS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="../../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></span>&nbsp;<span class="element-name">CHASSIS</span></div>
</section>
</li>
<li>
<section class="detail" id="LOOP_TIME">
<h3>LOOP_TIME</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">LOOP_TIME</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.LOOP_TIME">Constant Field Values</a></li>
</ul>
</dd>
</dl>
2023-08-29 19:59:07 -05:00
</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="&lt;init&gt;()">
2024-01-15 14:37:13 -06:00
<h3>Constants</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Constants</span>()</div>
2023-08-29 19:59:07 -05:00
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>