Difference between revisions of "BfbDevice Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(Created page with "BFB Device class implemets methods for using universal sensors as biofeedback system. =Android= ru.neurotech.neurodevices.bfb <span style="font-size: 150%;">'''Class BfbDev...")
 
(→‎Android)
 
(6 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
==Related Classes==
 
==Related Classes==
  
−
ru.neurotech.neurodevices.bfb.[[BfbDeviceConnector]]
+
ru.neurotech.neurodevices.bfb.[[BfbDeviceConnector Class|BfbDeviceConnector]]
  
−
ru.neurotech.neurodevices.bfb.[[BfbIndex]]
+
ru.neurotech.neurodevices.bfb.[[BfbIndex Class|BfbIndex]]
 +
 
 +
ru.neurotech.neurodevices.[[NeuroDevice Class|NeuroDevice]]
  
 
==Classes hierarchy==
 
==Classes hierarchy==
Line 21: Line 23:
  
 
<ul>
 
<ul>
−
<li>ru.neurotech.neurodevices.ecg.'''BfbDevice'''</li>
+
<li>ru.neurotech.neurodevices.bfb.'''BfbDevice'''</li>
 
</ul>
 
</ul>
 
</ul>
 
</ul>
Line 53: Line 55:
 
Returns Bluetooth LE MAC address
 
Returns Bluetooth LE MAC address
 
|- valign="top"
 
|- valign="top"
−
|style="color:#0066FF;" |[[BfbIndex#Android|BfbIndex]]
+
|style="color:#0066FF;" |[[BfbIndex Class#Android|BfbIndex]]
 
|[[#createIndex|createIndex]](<span style="color:#0066FF;">'''int'''</span> lowFrequency, <span style="color:#0066FF;">'''int'''</span> highFrequency, <span style="color:#0066FF;">'''double'''</span> windowDuration)
 
|[[#createIndex|createIndex]](<span style="color:#0066FF;">'''int'''</span> lowFrequency, <span style="color:#0066FF;">'''int'''</span> highFrequency, <span style="color:#0066FF;">'''double'''</span> windowDuration)
 
Creates biofeedback index with specified parameters
 
Creates biofeedback index with specified parameters
Line 75: Line 77:
 
|[[#stopReceive|stopReceive]]()
 
|[[#stopReceive|stopReceive]]()
 
|}
 
|}
−
<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
 
−
<ul class="blockList">
+
==Constructor Detail==
−
<li class="blockList"><a name="constructor.detail">
+
<code><span style="color:#0066FF;">'''public'''</span> BfbDevice(<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)</code>
−
<!--  -->
+
 
−
</a>
+
==Method Detail==
−
<h3>Constructor Detail</h3>
+
 
−
<a name="BfbDevice-long-">
+
<h3>finalize</h3>
−
<!--  -->
+
<code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</code>
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>BfbDevice</h4>
 
−
<pre>public&nbsp;BfbDevice(long&nbsp;nativeObjPtr)</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>close</h3>
−
<a name="close--">
+
<code><span style="color:#0066FF;">'''public void'''</span> close()</code>
−
<!--  -->
+
 
−
</a>
+
<h3>getName</h3>
−
<ul class="blockList">
+
<code><span style="color:#0066FF;">'''public'''</span> java.lang.String getName()</code>
−
<li class="blockList">
+
 
−
<h4>close</h4>
+
<span>'''Description copied from class: '''</span>[[VisualizableDevice Class#getName|VisualizableDevice]]
−
<pre>public&nbsp;void&nbsp;close()</pre>
+
 
−
</li>
+
Returns name of BLE device
−
</ul>
 
−
<a name="getName--">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>getName</h4>
 
−
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
 
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></span></div>
 
−
<div class="block">Returns name of BLE device</div>
 
 
<dl>
 
<dl>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
−
<dd><code>getName</code>&nbsp;in class&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></dd>
+
<dd><code>[[VisualizableDevice Class#getName|VisualizableDevice.getName()]]</code> in class VisualizableDevice</dd>
−
<dt><span class="returnLabel">Returns:</span></dt>
+
<dt><span>Returns:</span></dt>
 
<dd>BLE device name</dd>
 
<dd>BLE device name</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
 
−
<a name="getAddress--">
+
 
−
<!--  -->
+
<h3>getAddress</h3>
−
</a>
+
<code><span style="color:#0066FF;">'''public'''</span>&nbsp;java.lang.String&nbsp;getAddress()</code>
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<span>'''Description copied from class:''' [[VisualizableDevice Class|VisualizableDevice]]</span>
−
<h4>getAddress</h4>
+
 
−
<pre>public&nbsp;java.lang.String&nbsp;getAddress()</pre>
+
<div class="block">Returns Bluetooth LE MAC address
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></span></div>
 
−
<div class="block">Returns Bluetooth LE MAC address</div>
 
 
<dl>
 
<dl>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
−
<dd><code>getAddress</code>&nbsp;in class&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></dd>
+
<dd><code>[[VisualizableDevice Class#getDeviceAddress|VisualizableDevice.getAddress()]]</code> in class VisualizableDevice</dd>
−
<dt><span class="returnLabel">Returns:</span></dt>
+
<dt><span>Returns:</span></dt>
 
<dd>device unique address</dd>
 
<dd>device unique address</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>getBatteryLevel</h3>
−
<a name="getBatteryLevel--">
+
<code><span style="color:#0066FF;">'''public int'''</span> getBatteryLevel()</code>
−
<!--  -->
+
 
−
</a>
+
<span>'''Description copied from class:''' [[VisualizableDevice Class|VisualizableDevice]]</span>
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
Returns battery state
−
<h4>getBatteryLevel</h4>
+
 
−
<pre>public&nbsp;int&nbsp;getBatteryLevel()</pre>
 
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></span></div>
 
−
<div class="block">Returns battery state</div>
 
 
<dl>
 
<dl>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
−
<dd><code>getBatteryLevel</code>&nbsp;in class&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></dd>
+
<dd><code>[[VisualizableDevice Class#getBatteryLevel|VisualizableDevice.getBatteryLevel()]]</code>&nbsp;in class&nbsp;VisualizableDevice</dd>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dd>battery charge level in percents</dd>
 
<dd>battery charge level in percents</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>getNeuroDevice</h3>
−
<a name="getNeuroDevice--">
+
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDevice Class|NeuroDevice]]&nbsp;getNeuroDevice()</code>
−
<!--  -->
+
 
−
</a>
+
<span>'''Description copied from class:'''&nbsp;[[VisualizableDevice Class|VisualizableDevice]]</span>
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>getNeuroDevice</h4>
 
−
<pre>public&nbsp;ru.neurotech.neurodevices.NeuroDevice&nbsp;getNeuroDevice()</pre>
 
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></span></div>
 
 
<div class="block">Returns physical device object which this visual device represents</div>
 
<div class="block">Returns physical device object which this visual device represents</div>
 
<dl>
 
<dl>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
−
<dd><code>getNeuroDevice</code>&nbsp;in class&nbsp;<code>ru.neurotech.common.VisualizableDevice</code></dd>
+
<dd><code>[[VisualizableDevice Class#getNeuroDevice|VisualizableDevice.getNeuroDevice()]]</code>&nbsp;in class&nbsp;VisualizableDevice</dd>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dd>NeuroDevice of current visual device</dd>
 
<dd>NeuroDevice of current visual device</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>startReceive</h3>
−
<a name="startReceive--">
+
<code><span style="color:#0066FF;">'''public void'''</span> startReceive()</code>
−
<!--  -->
+
 
−
</a>
+
 
−
<ul class="blockList">
+
<h3>stopReceive</h3>
−
<li class="blockList">
+
<code><span style="color:#0066FF;">'''public void'''</span> stopReceive()</code>
−
<h4>startReceive</h4>
+
 
−
<pre>public&nbsp;void&nbsp;startReceive()</pre>
+
 
−
</li>
+
<h3>createIndex</h3>
−
</ul>
+
<code><span style="color:#0066FF;">'''public''' [[BfbIndex Class#Android|BfbIndex]]</span> createIndex(<span style="color:#0066FF;">'''int'''</span> lowFrequency, <span style="color:#0066FF;">'''int'''</span> highFrequency, <span style="color:#0066FF;">'''double'''</span> windowDuration)</code>
−
<a name="stopReceive--">
+
 
−
<!--  -->
+
Creates biofeedback index with specified parameters
−
</a>
+
 
−
<ul class="blockList">
+
<dl>
−
<li class="blockList">
+
<dt><span class="paramLabel">Parameters:</span></dt>
−
<h4>stopReceive</h4>
+
<dd><code>lowFrequency</code> - Low frequency of index band</dd>
−
<pre>public&nbsp;void&nbsp;stopReceive()</pre>
+
<dd><code>highFrequency</code> - High frequency of index band</dd>
−
</li>
+
<dd><code>windowDuration</code> - Duration of calculation window</dd>
−
</ul>
+
<dt><span class="returnLabel">Returns:</span></dt>
−
<a name="createIndex-int-int-double-">
+
<dd>Index object for biofeedback tests</dd>
−
<!--  -->
+
</dl>
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>createIndex</h4>
 
−
<pre>public&nbsp;<a href="../../../../ru/neurotech/neurodevices/bfb/BfbIndex.html" title="class in ru.neurotech.neurodevices.bfb">BfbIndex</a>&nbsp;createIndex(int&nbsp;lowFrequency,
 
−
                            int&nbsp;highFrequency,
 
−
                            double&nbsp;windowDuration)</pre>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</div>
 
−
</div>
 

Latest revision as of 05:35, 14 August 2017

BFB Device class implemets methods for using universal sensors as biofeedback system.

Android

ru.neurotech.neurodevices.bfb

Class BfbDevice

Related Classes

ru.neurotech.neurodevices.bfb.BfbDeviceConnector

ru.neurotech.neurodevices.bfb.BfbIndex

ru.neurotech.neurodevices.NeuroDevice

Classes hierarchy

  • java.lang.Object

Class definition

public class BfbDevice extends VisualizableDevice

Constructor Summary

Constructor and Description
BfbDevice(long nativeObjPtr)

Methods Summary

Modifier and Type Method and Description
void close()
void finalize()
java.lang.String getAddress()

Returns Bluetooth LE MAC address

BfbIndex createIndex(int lowFrequency, int highFrequency, double windowDuration)

Creates biofeedback index with specified parameters

int getBatteryLevel()

Returns battery charge level in percents

java.lang.String getName()

Returns name of BLE device

NeuroDevice getNeuroDevice()

Returns physical device object which this visual device represents

void startReceive()
void stopReceive()

Constructor Detail

public BfbDevice(long nativeObjPtr)

Method Detail

finalize

public void finalize() throws java.lang.Throwable

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

close

public void close()

getName

public java.lang.String getName()

Description copied from class: VisualizableDevice

Returns name of BLE device

Specified by:
VisualizableDevice.getName() in class VisualizableDevice
Returns:
BLE device name


getAddress

public java.lang.String getAddress()

Description copied from class: VisualizableDevice

Returns Bluetooth LE MAC address
Specified by:
VisualizableDevice.getAddress() in class VisualizableDevice
Returns:
device unique address

getBatteryLevel

public int getBatteryLevel()

Description copied from class: VisualizableDevice

Returns battery state

Specified by:
VisualizableDevice.getBatteryLevel() in class VisualizableDevice
Returns:
battery charge level in percents

getNeuroDevice

public NeuroDevice getNeuroDevice()

Description copied from class: VisualizableDevice

Returns physical device object which this visual device represents
Specified by:
VisualizableDevice.getNeuroDevice() in class VisualizableDevice
Returns:
NeuroDevice of current visual device

startReceive

public void startReceive()


stopReceive

public void stopReceive()


createIndex

public BfbIndex createIndex(int lowFrequency, int highFrequency, double windowDuration)

Creates biofeedback index with specified parameters

Parameters:
lowFrequency - Low frequency of index band
highFrequency - High frequency of index band
windowDuration - Duration of calculation window
Returns:
Index object for biofeedback tests
Retrieved from "http://wiki.callibri.com/index.php?title=BfbDevice_Class&oldid=232"