Difference between revisions of "BfbIndex Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(→‎Android)
(→‎Method Detail)
 
(6 intermediate revisions by the same user not shown)
Line 37: Line 37:
 
|}
 
|}
  
−
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
==Constructor Summary==
−
<ul class="blockList">
+
{| class="wikitable"
−
<li class="blockList"><a name="constructor.summary">
+
|- style="background-color: #dee3e9;"
−
<!--  -->
+
|'''Constructor and Description'''
−
</a>
+
|-
−
<h3>Constructor Summary</h3>
+
|[[#BfbIndex|BfbIndex]](<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)
−
<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">&nbsp;</span></caption>
+
 
−
<tr>
+
==Methods Summary==
−
<th class="colOne" scope="col">Constructor and Description</th>
+
{| class="wikitable"
−
</tr>
+
|- style="background-color: #dee3e9;"
−
<tr class="altColor">
+
|'''Modifier and Type'''
−
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#BfbIndex-long-">BfbIndex</a></span>(long&nbsp;objPtr)</code>&nbsp;</td>
+
|'''Method and Description'''
−
</tr>
+
|- valign="top"
−
</table>
+
|style="color:#0066FF;" |'''void'''
−
</li>
+
|[[#calibrate|calibrate]]()
−
</ul>
+
Starts calibration process
−
<!-- ========== METHOD SUMMARY =========== -->
+
|- valign="top"
−
<ul class="blockList">
+
|style="color:#0066FF;" |'''void'''
−
<li class="blockList"><a name="method.summary">
+
|[[#finalize|finalize]]()
−
<!--  -->
+
|- valign="top"
−
</a>
+
|style="color:#0066FF;" |'''int'''
−
<h3>Method Summary</h3>
+
|[[#value|value]]()
−
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+
Returns current value of biofeedback index
−
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+
|}
−
<tr>
+
 
−
<th class="colFirst" scope="col">Modifier and Type</th>
+
==Field Detail==
−
<th class="colLast" scope="col">Method and Description</th>
+
<h3>valueChanged</h3>
−
</tr>
+
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Integer&gt; valueChanged</code>
−
<tr id="i0" class="altColor">
+
 
−
<td class="colFirst"><code>void</code></td>
+
Notifies about changes of biofeedback
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#calibrate--">calibrate</a></span>()</code>&nbsp;</td>
+
 
−
</tr>
+
<h3>calibrationFinished</h3>
−
<tr id="i1" class="rowColor">
+
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Object&gt; calibrationFinished</code>
−
<td class="colFirst"><code>void</code></td>
+
 
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#finalize--">finalize</a></span>()</code>&nbsp;</td>
+
Notifies about finishing of calibration process
−
</tr>
+
 
−
<tr id="i2" class="altColor">
+
==Constructor Detail==
−
<td class="colFirst"><code>int</code></td>
+
 
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#value--">value</a></span>()</code>&nbsp;</td>
+
<code><span style="color:#0066FF;">'''public'''</span> BfbIndex(<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)</code>
−
</tr>
+
 
−
</table>
+
 
−
<ul class="blockList">
+
==Method Detail==
−
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+
 
−
<!--  -->
+
<h3>finalize</h3>
−
</a>
+
<code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</code>
−
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 
−
<code>clone, equals, 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="valueChanged">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>valueChanged</h4>
 
−
<pre>public final&nbsp;ru.neurotech.common.SubscribersNotifier&lt;java.lang.Integer&gt; valueChanged</pre>
 
−
<div class="block">Notifies when proper Callibri BFB device been found and initialized</div>
 
−
</li>
 
−
</ul>
 
−
<a name="calibrationFinished">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>calibrationFinished</h4>
 
−
<pre>public final&nbsp;ru.neurotech.common.SubscribersNotifier&lt;java.lang.Object&gt; calibrationFinished</pre>
 
−
<div class="block">Notifies about changing device scanning state</div>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
−
<ul class="blockList">
 
−
<li class="blockList"><a name="constructor.detail">
 
−
<!--  -->
 
−
</a>
 
−
<h3>Constructor Detail</h3>
 
−
<a name="BfbIndex-long-">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>BfbIndex</h4>
 
−
<pre>public&nbsp;BfbIndex(long&nbsp;objPtr)</pre>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
<!-- ============ METHOD DETAIL ========== -->
 
−
<ul class="blockList">
 
−
<li class="blockList"><a name="method.detail">
 
−
<!--  -->
 
−
</a>
 
−
<h3>Method Detail</h3>
 
−
<a name="finalize--">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>finalize</h4>
 
−
<pre>public&nbsp;void&nbsp;finalize()
 
−
              throws java.lang.Throwable</pre>
 
 
<dl>
 
<dl>
−
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+
<dt>Overrides:</dt>
 
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
−
<dt><span class="throwsLabel">Throws:</span></dt>
+
<dt>Throws:</dt>
 
<dd><code>java.lang.Throwable</code></dd>
 
<dd><code>java.lang.Throwable</code></dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>value</h3>
−
<a name="value--">
+
<code><span style="color:#0066FF;">'''public int'''</span> value()</code>
−
<!--  -->
+
 
−
</a>
+
Returns current value of biofeedback index
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<dl>
−
<h4>value</h4>
+
<dt><span class="returnLabel">Returns:</span></dt>
−
<pre>public&nbsp;int&nbsp;value()</pre>
+
<dd>Biofeedback index value</dd>
−
</li>
+
</dl>
−
</ul>
+
 
−
<a name="calibrate--">
+
<h3>calibrate</h3>
−
<!--  -->
+
<code><span style="color:#0066FF;">'''public void'''</span> calibrate()</code>
−
</a>
+
 
−
<ul class="blockListLast">
+
Starts calibration process. This method is non-blocking.
−
<li class="blockList">
+
Subscribe [[#calibrationFinished|calibrationFinished]] to get notification when calibration process ends.
−
<h4>calibrate</h4>
 
−
<pre>public&nbsp;void&nbsp;calibrate()</pre>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</div>
 
−
</div>
 
−
<!-- ========= END OF CLASS DATA ========= -->
 

Latest revision as of 09:51, 14 August 2017

Android

ru.neurotech.neurodevices.bfb

Class BfbIndex

Related Classes

ru.neurotech.neurodevices.bfb.BfbDeviceConnector

ru.neurotech.neurodevices.bfb.BfbDevice

Classes hierarchy

  • java.lang.Object
    • ru.neurotech.neurodevices.bfb.BfbIndex

Class definition

public class BfbIndex

Fields Summary

Modifier and Type Field and Description
SubscribersNotifier<java.lang.Object> calibrationFinished

Notifies about finishing of calibration process

SubscribersNotifier<java.lang.Integer> valueChanged

Notifies about changes of biofeedback index parameter

Constructor Summary

Constructor and Description
BfbIndex(long nativeObjPtr)

Methods Summary

Modifier and Type Method and Description
void calibrate()

Starts calibration process

void finalize()
int value()

Returns current value of biofeedback index

Field Detail

valueChanged

public final SubscribersNotifier<java.lang.Integer> valueChanged

Notifies about changes of biofeedback

calibrationFinished

public final SubscribersNotifier<java.lang.Object> calibrationFinished

Notifies about finishing of calibration process

Constructor Detail

public BfbIndex(long nativeObjPtr)


Method Detail

finalize

public void finalize() throws java.lang.Throwable

Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

value

public int value()

Returns current value of biofeedback index

Returns:
Biofeedback index value

calibrate

public void calibrate()

Starts calibration process. This method is non-blocking. Subscribe calibrationFinished to get notification when calibration process ends.

Retrieved from "http://wiki.callibri.com/index.php?title=BfbIndex_Class&oldid=242"