Difference between revisions of "BfbIndex Class"

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