Difference between revisions of "NeuroDevice Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(→‎Android)
(→‎Method Detail)
 
(4 intermediate revisions by the same user not shown)
Line 113: Line 113:
 
|}
 
|}
  
−
<!-- ============ FIELD DETAIL =========== -->
+
==Field Detail==
−
<ul class="blockList">
+
<h3>deviceStateChanged</h3>
−
<li class="blockList"><a name="field.detail">
+
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;[[NeuroDeviceState Enumeration|NeuroDeviceState]]&gt; deviceStateChanged</code>
−
<!--  -->
+
 
−
</a>
+
Subscribe this event to get notifications about device state
−
<h3>Field Detail</h3>
+
 
−
<a name="deviceStateChanged">
+
==Constructor Detail==
−
<!--  -->
+
 
−
</a>
+
<h3>NeuroDevice</h3>
−
<ul class="blockListLast">
+
<code><span style="color:#0066FF;">'''public'''</span> NeuroDevice(<span style="color:#0066FF;">'''long'''</span> nativeObjPtr)</code>
−
<li class="blockList">
+
 
−
<h4>deviceStateChanged</h4>
+
==Method Detail==
−
<pre>public&nbsp;<a href="../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a>&lt;<a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a>&gt; deviceStateChanged</pre>
+
 
−
<div class="block">Subscribe this event to get notifications about device state</div>
+
<h3>finalize</h3>
−
</li>
+
<code><span style="color:#0066FF;">'''public void'''</span> finalize() <span style="color:#0066FF;">throws</span> java.lang.Throwable</code>
−
</ul>
 
−
</li>
 
−
</ul>
 
−
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
−
<ul class="blockList">
 
−
<li class="blockList"><a name="constructor.detail">
 
−
<!--  -->
 
−
</a>
 
−
<h3>Constructor Detail</h3>
 
−
<a name="NeuroDevice-long-">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>NeuroDevice</h4>
 
−
<pre>public&nbsp;NeuroDevice(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>
+
 
−
<a name="close--">
+
<h3>close</h3>
−
<!--  -->
+
<code><span style="color:#0066FF;">'''public void'''</span> close()</code>
−
</a>
+
 
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<h3>getState</h3>
−
<h4>close</h4>
+
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDeviceState Enumeration|NeuroDeviceState]] getState()</code>
−
<pre>public&nbsp;void&nbsp;close()</pre>
+
 
−
<div class="block">Close device and free all resources</div>
+
Returns NeuroDevice state
−
</li>
 
−
</ul>
 
−
<a name="getState--">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>getState</h4>
 
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a>&nbsp;getState()</pre>
 
−
<div class="block">Returns common device state. To get error info call getError method</div>
 
 
<dl>
 
<dl>
−
<dt><span class="returnLabel">Returns:</span></dt>
+
<dt><span>Returns:</span></dt>
−
<dd>device state</dd>
+
<dd>Device state</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>getError</h3>
−
<a name="getError--">
+
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDeviceError Enumeration|NeuroDeviceError]] getError()</code>
−
<!--  -->
+
 
−
</a>
+
Returns error type if device is in error state
−
<ul class="blockList">
 
−
<li class="blockList">
 
−
<h4>getError</h4>
 
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceError.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceError</a>&nbsp;getError()</pre>
 
−
<div class="block">Returns device error state information</div>
 
 
<dl>
 
<dl>
−
<dt><span class="returnLabel">Returns:</span></dt>
+
<dt><span>Returns:</span></dt>
−
<dd>error type</dd>
+
<dd>Error type for device error state</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>getName</h3>
−
<a name="getName--">
+
<code><span style="color:#0066FF;">'''public'''</span> java.lang.String getName()</code>
−
<!--  -->
+
 
−
</a>
+
<span>'''Description copied from class: '''</span>[[VisualizableDevice Class#getName|VisualizableDevice]]
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
Returns name of BLE device
−
<h4>getName</h4>
 
−
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
 
−
<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><a href="../../../ru/neurotech/common/VisualizableDevice.html#getName--">getName</a></code>&nbsp;in class&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></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>
+
<h3>getAddress</h3>
−
<a name="getAddress--">
+
<code><span style="color:#0066FF;">'''public'''</span>&nbsp;java.lang.String&nbsp;getAddress()</code>
−
<!--  -->
+
 
−
</a>
+
<span>'''Description copied from class:''' [[VisualizableDevice Class|VisualizableDevice]]</span>
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<div class="block">Returns Bluetooth LE MAC address
−
<h4>getAddress</h4>
 
−
<pre>public&nbsp;java.lang.String&nbsp;getAddress()</pre>
 
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">VisualizableDevice</a></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><a href="../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">getAddress</a></code>&nbsp;in class&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></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">Returns battery state</div>
 
 
<dl>
 
<dl>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
−
<dd><code><a href="../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">getBatteryLevel</a></code>&nbsp;in class&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></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">
+
Returns this object. This method is for comapatability with VisualizableDevice class interface, inherited to use NeuroDevice in scopes where VisualizableDevice is needed
−
<li class="blockList">
 
−
<h4>getNeuroDevice</h4>
 
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a>&nbsp;getNeuroDevice()</pre>
 
−
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">VisualizableDevice</a></code></span></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><a href="../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">getNeuroDevice</a></code>&nbsp;in class&nbsp;<code><a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></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>This NeuroDevice object</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
 
−
<a name="getSignalSubsystem--">
+
<h3>getSignalSubsystem</h3>
−
<!--  -->
+
<code><span style="color:#0066FF;">'''public'''</span> [[SignalSubsystem Class|SignalSubsystem]]&nbsp;getSignalSubsystem()</code>
−
</a>
+
 
−
<ul class="blockList">
+
Returns subsystem for SIGNAL device feature
−
<li class="blockList">
+
 
−
<h4>getSignalSubsystem</h4>
 
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/features/SignalSubsystem.html" title="class in ru.neurotech.neurodevices.features">SignalSubsystem</a>&nbsp;getSignalSubsystem()</pre>
 
−
<div class="block">Returns subsystem for SIGNAL device feature</div>
 
 
<dl>
 
<dl>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dd>Signal subsystem of device. Null if is not supported</dd>
 
<dd>Signal subsystem of device. Null if is not supported</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>getStimulationSubsystem</h3>
−
<a name="getStimulationSubsystem--">
+
<code><span style="color:#0066FF;">'''public'''</span> [[StimulationSubsystem Class|StimulationSubsystem]]&nbsp;getStimulationSubsystem()</code>
−
<!--  -->
+
 
−
</a>
+
Returns subsystem for STIMUL device feature
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<dl>
−
<h4>getStimulationSubsystem</h4>
+
<dt><span class="returnLabel">Returns:</span></dt>
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/features/StimulationSubsystem.html" title="class in ru.neurotech.neurodevices.features">StimulationSubsystem</a>&nbsp;getStimulationSubsystem()</pre>
+
<dd>Stimulation subsystem of device. Null if is not supported</dd>
−
</li>
+
</dl>
−
</ul>
+
 
−
<a name="getFeatures--">
+
<h3>getFeatures</h3>
−
<!--  -->
+
<code><span style="color:#0066FF;">'''public'''</span> [[DeviceFeature Enumeration|DeviceFeature]][]&nbsp;getFeatures()</code>
−
</a>
+
 
−
<ul class="blockList">
+
Returns supported device features
−
<li class="blockList">
+
 
−
<h4>getFeatures</h4>
 
−
<pre>public&nbsp;<a href="../../../ru/neurotech/neurodevices/DeviceFeature.html" title="enum in ru.neurotech.neurodevices">DeviceFeature</a>[]&nbsp;getFeatures()</pre>
 
−
<div class="block">Returns supported device features</div>
 
 
<dl>
 
<dl>
 
<dt><span class="returnLabel">Returns:</span></dt>
 
<dt><span class="returnLabel">Returns:</span></dt>
−
<dd>device feature</dd>
+
<dd>Device features</dd>
 
</dl>
 
</dl>
−
</li>
+
 
−
</ul>
+
<h3>connect</h3>
−
<a name="connect--">
+
<code><span style="color:#0066FF;">'''public void'''</span> connect()</code>
−
<!--  -->
+
 
−
</a>
+
Establishes connection with device services
−
<ul class="blockList">
+
 
−
<li class="blockList">
+
<h3>disconnect</h3>
−
<h4>connect</h4>
+
<code><span style="color:#0066FF;">'''public void'''</span> disconnect()</code>
−
<pre>public&nbsp;void&nbsp;connect()</pre>
+
 
−
<div class="block">Establishes connection with device services</div>
+
Disconnects from device
−
</li>
 
−
</ul>
 
−
<a name="disconnect--">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>disconnect</h4>
 
−
<pre>public&nbsp;void&nbsp;disconnect()</pre>
 
−
<div class="block">Disconnect from device</div>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
−
</div>
 
−
</div>
 

Latest revision as of 06:23, 9 August 2017

Android

ru.neurotech.neurodevices

Class NeuroDevice

Related Classes

ru.neurotech.neurodevices.NeuroConnection

ru.neurotech.neurodevices.DeviceFeature

ru.neurotech.neurodevices.state.NeuroDeviceError

ru.neurotech.neurodevices.state.NeuroDeviceState

Classes hierarchy

  • java.lang.Object

Class definition

public class NeuroDevice extends VisualizableDevice

Represents Neurotech™ device on a layer of algorithmic functionality

Provides signal and misc channels and methods for signal processing and viewing</div>


Fields Summary

Modifier and Type Field and Description
SubscribersNotifier<NeuroDeviceState> deviceStateChanged

Subscribe this event to get notifications about device state

Constructor Summary

Constructor and Description
NeuroDevice(long nativeObjPtr)

Methods Summary

Modifier and Type Method and Description
void close()

Close device and free all resources

void connect()

Establishes connection with device services

void disconnect()

Disconnects from device

void finalize()
java.lang.String getAddress()

Returns Bluetooth LE MAC address

int getBatteryLevel()

Returns battery charge level in percents

NeuroDeviceError getError()

Returns device error state information

DeviceFeature[] getFeature()

Returns supported device features

java.lang.String getName()

Returns name of BLE device

NeuroDevice getNeuroDevice()

Returns this object

SignalSubsystem getSignalSubsystem()

Returns subsystem for SIGNAL device feature

NeuroDeviceState getState()

Returns common device state

StimulationSubsystem getStimulationSubsystem()

Returns subsystem for STIMUL device feature

Field Detail

deviceStateChanged

public final SubscribersNotifier<NeuroDeviceState> deviceStateChanged

Subscribe this event to get notifications about device state

Constructor Detail

NeuroDevice

public NeuroDevice(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()


getState

public NeuroDeviceState getState()

Returns NeuroDevice state

Returns:
Device state

getError

public NeuroDeviceError getError()

Returns error type if device is in error state

Returns:
Error type for device error state

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 this object. This method is for comapatability with VisualizableDevice class interface, inherited to use NeuroDevice in scopes where VisualizableDevice is needed

Specified by:
VisualizableDevice.getNeuroDevice() in class VisualizableDevice
Returns:
This NeuroDevice object


getSignalSubsystem

public SignalSubsystem getSignalSubsystem()

Returns subsystem for SIGNAL device feature

Returns:
Signal subsystem of device. Null if is not supported

getStimulationSubsystem

public StimulationSubsystem getStimulationSubsystem()

Returns subsystem for STIMUL device feature

Returns:
Stimulation subsystem of device. Null if is not supported

getFeatures

public DeviceFeature[] getFeatures()

Returns supported device features

Returns:
Device features

connect

public void connect()

Establishes connection with device services

disconnect

public void disconnect()

Disconnects from device
Retrieved from "http://wiki.callibri.com/index.php?title=NeuroDevice_Class&oldid=224"