Difference between revisions of "BfbIndex Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(Created page with "=Android=")
 
(→‎Method Detail)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=Android=
 
=Android=
 +
ru.neurotech.neurodevices.bfb
 +
 +
<span style="font-size: 150%;">'''Class BfbIndex'''</span>
 +
 +
==Related Classes==
 +
 +
ru.neurotech.neurodevices.bfb.[[BfbDeviceConnector Class|BfbDeviceConnector]]
 +
 +
ru.neurotech.neurodevices.bfb.[[BfbDevice Class|BfbDevice]]
 +
 +
==Classes hierarchy==
 +
<ul>
 +
<li>java.lang.Object</li>
 +
 +
<ul>
 +
<li>ru.neurotech.neurodevices.bfb.'''BfbIndex'''</li>
 +
</ul>
 +
</ul>
 +
 +
==Class definition==
 +
<code><span style="color:#0066FF;">'''public class'''</span> BfbIndex </code>
 +
 +
==Fields Summary==
 +
{| class="wikitable"
 +
|- style="background-color: #dee3e9;"
 +
|'''Modifier and Type'''
 +
|'''Field and Description'''
 +
|- valign="top"
 +
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Object&gt;
 +
|[[#calibrationFinished|calibrationFinished]]
 +
Notifies about finishing of calibration process
 +
|-  valign="top"
 +
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Integer&gt;
 +
|[[#valueChanged|valueChanged]]
 +
Notifies about changes of biofeedback index parameter
 +
|}
 +
 +
==Constructor Summary==
 +
{| class="wikitable"
 +
|- style="background-color: #dee3e9;"
 +
|'''Constructor and Description'''
 +
|-
 +
|[[#BfbIndex|BfbIndex]](<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)
 +
|}
 +
 +
==Methods Summary==
 +
{| class="wikitable"
 +
|- style="background-color: #dee3e9;"
 +
|'''Modifier and Type'''
 +
|'''Method and Description'''
 +
|- valign="top"
 +
|style="color:#0066FF;" |'''void'''
 +
|[[#calibrate|calibrate]]()
 +
Starts calibration process
 +
|- valign="top"
 +
|style="color:#0066FF;" |'''void'''
 +
|[[#finalize|finalize]]()
 +
|- valign="top"
 +
|style="color:#0066FF;" |'''int'''
 +
|[[#value|value]]()
 +
Returns current value of biofeedback index
 +
|}
 +
 +
==Field Detail==
 +
<h3>valueChanged</h3>
 +
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Integer&gt; valueChanged</code>
 +
 +
Notifies about changes of biofeedback
 +
 +
<h3>calibrationFinished</h3>
 +
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Object&gt; calibrationFinished</code>
 +
 +
Notifies about finishing of calibration process
 +
 +
==Constructor Detail==
 +
 +
<code><span style="color:#0066FF;">'''public'''</span> BfbIndex(<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)</code>
 +
 +
 +
==Method Detail==
 +
 +
<h3>finalize</h3>
 +
<code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</code>
 +
<dl>
 +
<dt>Overrides:</dt>
 +
<dd><code>finalize</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 +
<dt>Throws:</dt>
 +
<dd><code>java.lang.Throwable</code></dd>
 +
</dl>
 +
 +
<h3>value</h3>
 +
<code><span style="color:#0066FF;">'''public int'''</span> value()</code>
 +
 +
Returns current value of biofeedback index
 +
 +
<dl>
 +
<dt><span class="returnLabel">Returns:</span></dt>
 +
<dd>Biofeedback index value</dd>
 +
</dl>
 +
 +
<h3>calibrate</h3>
 +
<code><span style="color:#0066FF;">'''public void'''</span> calibrate()</code>
 +
 +
Starts calibration process. This method is non-blocking.
 +
Subscribe [[#calibrationFinished|calibrationFinished]] to get notification when calibration process ends.

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"