Difference between revisions of "BfbIndex Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(→‎Classes hierarchy)
(→‎Method Detail)
 
(7 intermediate revisions by the same user not shown)
Line 22: Line 22:
 
<code><span style="color:#0066FF;">'''public class'''</span> BfbIndex </code>
 
<code><span style="color:#0066FF;">'''public class'''</span> BfbIndex </code>
  
−
<!-- =========== FIELD SUMMARY =========== -->
+
==Fields Summary==
−
<ul class="blockList">
+
{| class="wikitable"
−
<li class="blockList"><a name="field.summary">
+
|- style="background-color: #dee3e9;"
−
<!--  -->
+
|'''Modifier and Type'''
−
</a>
+
|'''Field and Description'''
−
<h3>Field Summary</h3>
+
|- valign="top"
−
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Object&gt;
−
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
+
|[[#calibrationFinished|calibrationFinished]]
−
<tr>
+
Notifies about finishing of calibration process
−
<th class="colFirst" scope="col">Modifier and Type</th>
+
|-  valign="top"
−
<th class="colLast" scope="col">Field and Description</th>
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Integer&gt;
−
</tr>
+
|[[#valueChanged|valueChanged]]
−
<tr class="altColor">
+
Notifies about changes of biofeedback index parameter
−
<td class="colFirst"><code>ru.neurotech.common.SubscribersNotifier&lt;java.lang.Object&gt;</code></td>
+
|}
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#calibrationFinished">calibrationFinished</a></span></code>
+
 
−
<div class="block">Notifies about changing device scanning state</div>
+
==Constructor Summary==
−
</td>
+
{| class="wikitable"
−
</tr>
+
|- style="background-color: #dee3e9;"
−
<tr class="rowColor">
+
|'''Constructor and Description'''
−
<td class="colFirst"><code>ru.neurotech.common.SubscribersNotifier&lt;java.lang.Integer&gt;</code></td>
+
|-
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#valueChanged">valueChanged</a></span></code>
+
|[[#BfbIndex|BfbIndex]](<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)
−
<div class="block">Notifies when proper Callibri BFB device been found and initialized</div>
+
|}
−
</td>
+
 
−
</tr>
+
==Methods Summary==
−
</table>
+
{| class="wikitable"
−
</li>
+
|- style="background-color: #dee3e9;"
−
</ul>
+
|'''Modifier and Type'''
−
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
|'''Method and Description'''
−
<ul class="blockList">
+
|- valign="top"
−
<li class="blockList"><a name="constructor.summary">
+
|style="color:#0066FF;" |'''void'''
−
<!--  -->
+
|[[#calibrate|calibrate]]()
−
</a>
+
Starts calibration process
−
<h3>Constructor Summary</h3>
+
|- valign="top"
−
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+
|style="color:#0066FF;" |'''void'''
−
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+
|[[#finalize|finalize]]()
−
<tr>
+
|- valign="top"
−
<th class="colOne" scope="col">Constructor and Description</th>
+
|style="color:#0066FF;" |'''int'''
−
</tr>
+
|[[#value|value]]()
−
<tr class="altColor">
+
Returns current value of biofeedback index
−
<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>
+
|}
−
</tr>
+
 
−
</table>
+
==Field Detail==
−
</li>
+
<h3>valueChanged</h3>
−
</ul>
+
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Integer&gt; valueChanged</code>
−
<!-- ========== METHOD SUMMARY =========== -->
+
 
−
<ul class="blockList">
+
Notifies about changes of biofeedback
−
<li class="blockList"><a name="method.summary">
+
 
−
<!--  -->
+
<h3>calibrationFinished</h3>
−
</a>
+
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Object&gt; calibrationFinished</code>
−
<h3>Method Summary</h3>
+
 
−
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+
Notifies about finishing of calibration process
−
<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>
+
==Constructor Detail==
−
<th class="colFirst" scope="col">Modifier and Type</th>
+
 
−
<th class="colLast" scope="col">Method and Description</th>
+
<code><span style="color:#0066FF;">'''public'''</span> BfbIndex(<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)</code>
−
</tr>
+
 
−
<tr id="i0" class="altColor">
+
 
−
<td class="colFirst"><code>void</code></td>
+
==Method Detail==
−
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html#calibrate--">calibrate</a></span>()</code>&nbsp;</td>
+
 
−
</tr>
+
<h3>finalize</h3>
−
<tr id="i1" class="rowColor">
+
<code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</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>
 
−
</tr>
 
−
<tr id="i2" class="altColor">
 
−
<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>
 
−
</tr>
 
−
</table>
 
−
<ul class="blockList">
 
−
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 
−
<!--  -->
 
−
</a>
 
−
<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"