wpilib18/java/current/javadoc/edu/wpi/first/wpilibj/AnalogTrigger.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 05:22:52 EDT 2017 -->
<title>AnalogTrigger (Documentation - Release API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AnalogTrigger (Documentation - Release API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/wpilibj/AnalogPotentiometer.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.AnalogTriggerException.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/AnalogTrigger.html" target="_top">Frames</a></li>
<li><a href="AnalogTrigger.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </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="subNavList">
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.wpi.first.wpilibj</div>
<h2 title="Class AnalogTrigger" class="title">Class AnalogTrigger</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.wpi.first.wpilibj.AnalogTrigger</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AnalogTrigger</span>
extends java.lang.Object</pre>
<div class="block">Class for creating and configuring Analog Triggers.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.AnalogTriggerException.html" title="class in edu.wpi.first.wpilibj">AnalogTrigger.AnalogTriggerException</a></span></code>
<div class="block">Exceptions dealing with improper operation of the Analog trigger.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../edu/wpi/first/wpilibj/AnalogInput.html" title="class in edu.wpi.first.wpilibj">AnalogInput</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#m_analogInput">m_analogInput</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#m_index">m_index</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#m_ownsAnalog">m_ownsAnalog</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#m_port">m_port</a></span></code>
<div class="block">Where the analog trigger is attached.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#AnalogTrigger-edu.wpi.first.wpilibj.AnalogInput-">AnalogTrigger</a></span>(<a href="../../../../edu/wpi/first/wpilibj/AnalogInput.html" title="class in edu.wpi.first.wpilibj">AnalogInput</a> channel)</code>
<div class="block">Construct an analog trigger given an analog channel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#AnalogTrigger-int-">AnalogTrigger</a></span>(int channel)</code>
<div class="block">Constructor for an analog trigger given a channel number.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.html" title="class in edu.wpi.first.wpilibj">AnalogTriggerOutput</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#createOutput-edu.wpi.first.wpilibj.AnalogTriggerOutput.AnalogTriggerType-">createOutput</a></span>(<a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.AnalogTriggerType.html" title="enum in edu.wpi.first.wpilibj">AnalogTriggerOutput.AnalogTriggerType</a> type)</code>
<div class="block">Creates an AnalogTriggerOutput object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#free--">free</a></span>()</code>
<div class="block">Release the resources used by this object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#getIndex--">getIndex</a></span>()</code>
<div class="block">Return the index of the analog trigger.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#getInWindow--">getInWindow</a></span>()</code>
<div class="block">Return the InWindow output of the analog trigger.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#getTriggerState--">getTriggerState</a></span>()</code>
<div class="block">Return the TriggerState output of the analog trigger.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#setAveraged-boolean-">setAveraged</a></span>(boolean useAveragedValue)</code>
<div class="block">Configure the analog trigger to use the averaged vs.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#setFiltered-boolean-">setFiltered</a></span>(boolean useFilteredValue)</code>
<div class="block">Configure the analog trigger to use a filtered value.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#setLimitsRaw-int-int-">setLimitsRaw</a></span>(int lower,
int upper)</code>
<div class="block">Set the upper and lower limits of the analog trigger.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.html#setLimitsVoltage-double-double-">setLimitsVoltage</a></span>(double lower,
double upper)</code>
<div class="block">Set the upper and lower limits of the analog trigger.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="m_port">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_port</h4>
<pre>protected int m_port</pre>
<div class="block">Where the analog trigger is attached.</div>
</li>
</ul>
<a name="m_index">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_index</h4>
<pre>protected int m_index</pre>
</li>
</ul>
<a name="m_analogInput">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>m_analogInput</h4>
<pre>protected <a href="../../../../edu/wpi/first/wpilibj/AnalogInput.html" title="class in edu.wpi.first.wpilibj">AnalogInput</a> m_analogInput</pre>
</li>
</ul>
<a name="m_ownsAnalog">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>m_ownsAnalog</h4>
<pre>protected boolean m_ownsAnalog</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AnalogTrigger-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AnalogTrigger</h4>
<pre>public AnalogTrigger(int channel)</pre>
<div class="block">Constructor for an analog trigger given a channel number.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the port to use for the analog trigger</dd>
</dl>
</li>
</ul>
<a name="AnalogTrigger-edu.wpi.first.wpilibj.AnalogInput-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AnalogTrigger</h4>
<pre>public AnalogTrigger(<a href="../../../../edu/wpi/first/wpilibj/AnalogInput.html" title="class in edu.wpi.first.wpilibj">AnalogInput</a> channel)</pre>
<div class="block">Construct an analog trigger given an analog channel. This should be used in the case of sharing
an analog channel between the trigger and an analog input object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - the AnalogInput to use for the analog trigger</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="free--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>public void free()</pre>
<div class="block">Release the resources used by this object.</div>
</li>
</ul>
<a name="setLimitsRaw-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLimitsRaw</h4>
<pre>public void setLimitsRaw(int lower,
int upper)</pre>
<div class="block">Set the upper and lower limits of the analog trigger. The limits are given in ADC codes. If
oversampling is used, the units must be scaled appropriately.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lower</code> - the lower raw limit</dd>
<dd><code>upper</code> - the upper raw limit</dd>
</dl>
</li>
</ul>
<a name="setLimitsVoltage-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLimitsVoltage</h4>
<pre>public void setLimitsVoltage(double lower,
double upper)</pre>
<div class="block">Set the upper and lower limits of the analog trigger. The limits are given as floating point
voltage values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lower</code> - the lower voltage limit</dd>
<dd><code>upper</code> - the upper voltage limit</dd>
</dl>
</li>
</ul>
<a name="setAveraged-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAveraged</h4>
<pre>public void setAveraged(boolean useAveragedValue)</pre>
<div class="block">Configure the analog trigger to use the averaged vs. raw values. If the value is true, then the
averaged value is selected for the analog trigger, otherwise the immediate value is used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useAveragedValue</code> - true to use an averaged value, false otherwise</dd>
</dl>
</li>
</ul>
<a name="setFiltered-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFiltered</h4>
<pre>public void setFiltered(boolean useFilteredValue)</pre>
<div class="block">Configure the analog trigger to use a filtered value. The analog trigger will operate with a 3
point average rejection filter. This is designed to help with 360 degree pot applications for
the period where the pot crosses through zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useFilteredValue</code> - true to use a filtered value, false otherwise</dd>
</dl>
</li>
</ul>
<a name="getIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndex</h4>
<pre>public int getIndex()</pre>
<div class="block">Return the index of the analog trigger. This is the FPGA index of this analog trigger
instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The index of the analog trigger.</dd>
</dl>
</li>
</ul>
<a name="getInWindow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInWindow</h4>
<pre>public boolean getInWindow()</pre>
<div class="block">Return the InWindow output of the analog trigger. True if the analog input is between the upper
and lower limits.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The InWindow output of the analog trigger.</dd>
</dl>
</li>
</ul>
<a name="getTriggerState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTriggerState</h4>
<pre>public boolean getTriggerState()</pre>
<div class="block">Return the TriggerState output of the analog trigger. True if above upper limit. False if below
lower limit. If in Hysteresis, maintain previous state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The TriggerState output of the analog trigger.</dd>
</dl>
</li>
</ul>
<a name="createOutput-edu.wpi.first.wpilibj.AnalogTriggerOutput.AnalogTriggerType-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createOutput</h4>
<pre>public <a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.html" title="class in edu.wpi.first.wpilibj">AnalogTriggerOutput</a> createOutput(<a href="../../../../edu/wpi/first/wpilibj/AnalogTriggerOutput.AnalogTriggerType.html" title="enum in edu.wpi.first.wpilibj">AnalogTriggerOutput.AnalogTriggerType</a> type)</pre>
<div class="block">Creates an AnalogTriggerOutput object. Gets an output object that can be used for routing.
Caller is responsible for deleting the AnalogTriggerOutput object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - An enum of the type of output object to create.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A pointer to a new AnalogTriggerOutput object.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../edu/wpi/first/wpilibj/AnalogPotentiometer.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/wpi/first/wpilibj/AnalogTrigger.AnalogTriggerException.html" title="class in edu.wpi.first.wpilibj"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/wpi/first/wpilibj/AnalogTrigger.html" target="_top">Frames</a></li>
<li><a href="AnalogTrigger.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </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="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>