| <!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_112) on Sun Feb 26 17:08:10 EST 2017 --> |
| <title>SimpleSimulatedSensor (Edgent v1.1.0)</title> |
| <meta name="date" content="2017-02-26"> |
| <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="SimpleSimulatedSensor (Edgent v1.1.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="class-use/SimpleSimulatedSensor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-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="../../../../../../org/apache/edgent/samples/utils/sensor/PeriodicRandomSensor.html" title="class in org.apache.edgent.samples.utils.sensor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimulatedSensors.html" title="class in org.apache.edgent.samples.utils.sensor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html" target="_top">Frames</a></li> |
| <li><a href="SimpleSimulatedSensor.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>Nested | </li> |
| <li>Field | </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>Field | </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">org.apache.edgent.samples.utils.sensor</div> |
| <h2 title="Class SimpleSimulatedSensor" class="title">Class SimpleSimulatedSensor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.edgent.samples.utils.sensor.SimpleSimulatedSensor</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.Double></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SimpleSimulatedSensor</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.Double></pre> |
| <div class="block">A simple simulated sensor. |
| <p> |
| The sensor starts off with an initial value. |
| Each call to <a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#get--"><code>get()</code></a> changes the current value by |
| a random amount between plus/minus <code>deltaFactor</code>. |
| The new current value is limited to a <code>range</code> |
| and then rounded to 1 fractional digit. |
| See <a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#setNumberFractionalDigits-int-"><code>setNumberFractionalDigits(int)</code></a>. |
| </p><p> |
| Sample use: |
| <pre><code> |
| Topology t = ...; |
| // a miles-per-gallon sensor |
| SimpleSimulatedSensor avgMpgSensor = new SimpleSimulatedSensor(10.5, 0.4, |
| Ranges<Double>.closed(7.0,14.0)); |
| TStream<Double> avgMpg = t.poll(avgMpgSensor, 1, TimeUnit.SECONDS); |
| |
| // an integer valued sensor |
| SimpleSimulatedSensor doubleSensor = new SimpleSimulatedSensor(); |
| TStream<Integer> intSensor = t.poll(() -> doubleSensor.get().intValue(), |
| 1, TimeUnit.SECONDS); |
| </code></pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.edgent.samples.utils.sensor.SimpleSimulatedSensor">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#SimpleSimulatedSensor--">SimpleSimulatedSensor</a></span>()</code> |
| <div class="block">Create a sensor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#SimpleSimulatedSensor-double-">SimpleSimulatedSensor</a></span>(double initialValue)</code> |
| <div class="block">Create a sensor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#SimpleSimulatedSensor-double-double-">SimpleSimulatedSensor</a></span>(double initialValue, |
| double deltaFactor)</code> |
| <div class="block">Create a sensor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#SimpleSimulatedSensor-double-double-org.apache.edgent.analytics.sensors.Range-">SimpleSimulatedSensor</a></span>(double initialValue, |
| double deltaFactor, |
| <a href="../../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><java.lang.Double> range)</code> |
| <div class="block">Create a sensor.</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>java.lang.Double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#get--">get</a></span>()</code> |
| <div class="block">Get the next sensor value as described in the class documentation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#getDeltaFactor--">getDeltaFactor</a></span>()</code> |
| <div class="block">Get the deltaFactor setting</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#getNumberFractionalDigits--">getNumberFractionalDigits</a></span>()</code> |
| <div class="block">Get the number of fractional digits setting</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><java.lang.Double></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#getRange--">getRange</a></span>()</code> |
| <div class="block">Get the range setting</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#setNumberFractionalDigits-int-">setNumberFractionalDigits</a></span>(int numFracDigits)</code> |
| <div class="block">Set number of fractional digits to round sensor values to.</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SimpleSimulatedSensor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleSimulatedSensor</h4> |
| <pre>public SimpleSimulatedSensor()</pre> |
| <div class="block">Create a sensor. |
| <p> |
| Same as <code>SimpleSimulatedSensor(0.0, 1.0, null)</code>; |
| </p></div> |
| </li> |
| </ul> |
| <a name="SimpleSimulatedSensor-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleSimulatedSensor</h4> |
| <pre>public SimpleSimulatedSensor(double initialValue)</pre> |
| <div class="block">Create a sensor. |
| <p> |
| Same as <code>SimpleSimulatedSensor(initialValue, 1.0, null)</code>; |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialValue</code> - the initial value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SimpleSimulatedSensor-double-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleSimulatedSensor</h4> |
| <pre>public SimpleSimulatedSensor(double initialValue, |
| double deltaFactor)</pre> |
| <div class="block">Create a sensor. |
| |
| <p> |
| Same as <code>SimpleSimulatedSensor(initialValue, deltaFactor, null)</code>; |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialValue</code> - the initial value.</dd> |
| <dd><code>deltaFactor</code> - maximum plus/minus change on each <code>get()</code>. |
| e.g., 1.0 to limit change to +/- 1.0. |
| Must be > 0.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SimpleSimulatedSensor-double-double-org.apache.edgent.analytics.sensors.Range-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SimpleSimulatedSensor</h4> |
| <pre>public SimpleSimulatedSensor(double initialValue, |
| double deltaFactor, |
| <a href="../../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><java.lang.Double> range)</pre> |
| <div class="block">Create a sensor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialValue</code> - the initial value. Must be within range.</dd> |
| <dd><code>deltaFactor</code> - maximum plus/minus change on each <a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html#get--"><code>get()</code></a>. |
| e.g., 1.0 to limit change to +/- 1.0. |
| Must be > 0.0</dd> |
| <dd><code>range</code> - maximum sensor value range. Unlimited if null.</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="setNumberFractionalDigits-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumberFractionalDigits</h4> |
| <pre>public void setNumberFractionalDigits(int numFracDigits)</pre> |
| <div class="block">Set number of fractional digits to round sensor values to. |
| <p> |
| This class offers rounding as a convenience and because |
| ancestors of this implementation had such a scheme. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numFracDigits</code> - if <= 0, no rounding will be performed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNumberFractionalDigits--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumberFractionalDigits</h4> |
| <pre>public int getNumberFractionalDigits()</pre> |
| <div class="block">Get the number of fractional digits setting</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRange</h4> |
| <pre>public <a href="../../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><java.lang.Double> getRange()</pre> |
| <div class="block">Get the range setting</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeltaFactor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeltaFactor</h4> |
| <pre>public double getDeltaFactor()</pre> |
| <div class="block">Get the deltaFactor setting</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public java.lang.Double get()</pre> |
| <div class="block">Get the next sensor value as described in the class documentation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/edgent/function/Supplier.html#get--">get</a></code> in interface <code><a href="../../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><java.lang.Double></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Value supplied by this function.</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="class-use/SimpleSimulatedSensor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/edgent/samples/utils/sensor/PeriodicRandomSensor.html" title="class in org.apache.edgent.samples.utils.sensor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/edgent/samples/utils/sensor/SimulatedSensors.html" title="class in org.apache.edgent.samples.utils.sensor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/edgent/samples/utils/sensor/SimpleSimulatedSensor.html" target="_top">Frames</a></li> |
| <li><a href="SimpleSimulatedSensor.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>Nested | </li> |
| <li>Field | </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>Field | </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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> |
| </body> |
| </html> |
