View source for NeuroDevice Class

=Android=

ru.neurotech.neurodevices

<span style="font-size: 150%;">'''Class NeuroDevice'''</span>

==Related Classes==

ru.neurotech.neurodevices.[[NeuroConnection Class|NeuroConnection]]

ru.neurotech.neurodevices.[[DeviceFeature Enumeration|DeviceFeature]]

ru.neurotech.neurodevices.state.[[NeuroDeviceError Enumeration|NeuroDeviceError]]

ru.neurotech.neurodevices.state.[[NeuroDeviceState Enumeration|NeuroDeviceState]]

==Classes hierarchy==
<ul>
<li>java.lang.Object</li>

<ul>
<li>ru.neurotech.common.[[VisualizableDevice Class|VisualizableDevice]]</li>

<ul>
<li>ru.neurotech.neurodevices.'''NeuroDevice'''</li>
</ul>
</ul>
</ul>

==Class definition==
<code><span style="color:#0066FF;">'''public class'''</span> NeuroDevice <span style="color:#0066FF;">'''extends'''</span> [[VisualizableDevice Class|VisualizableDevice]]</code>

Represents Neurotech™ device on a layer of algorithmic functionality

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


==Fields Summary==
{| class="wikitable"
|- style="background-color: #dee3e9;"
|'''Modifier and Type'''
|'''Field and Description'''
|- valign="top"
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;'''[[NeuroDeviceState Enumeration|NeuroDeviceState]]'''&gt;
|[[#deviceStateChanged|'''deviceStateChanged''']]
Subscribe this event to get notifications about device state
|}

==Constructor Summary==
{| class="wikitable"
|- style="background-color: #dee3e9;"
|'''Constructor and Description'''
|-
|[[#NeuroDevice|NeuroDevice]](<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'''
|[[#close|close]]()
Close device and free all resources
|- valign="top"
|style="color:#0066FF;" |'''void'''
|[[#connect|connect]]()
Establishes connection with device services
|- valign="top"
|style="color:#0066FF;" |'''void'''
|[[#disconnect|disconnect]]()
Disconnects from device
|- valign="top"
|style="color:#0066FF;" |'''void'''
|[[#finalize|finalize]]()
|- valign="top"
|java.lang.String
|[[#getAddress|getAddress]]()
Returns Bluetooth LE MAC address
|- valign="top"
|style="color:#0066FF;" |'''int'''
|[[#getBatteryLevel|getBatteryLevel]]()
Returns battery charge level in percents
|- valign="top"
|[[NeuroDeviceError Enumeration|NeuroDeviceError]]
|[[#getError|getError]]()
Returns device error state information
|- valign="top"
|[[DeviceFeature Enumeration|DeviceFeature]][]
|[[#getFeature|getFeature]]()
Returns supported device features
|- valign="top"
|java.lang.String
|[[#getName|getName]]()
Returns name of BLE device
|- valign="top"
|style="color:#0066FF;" |[[NeuroDevice Class#Android|NeuroDevice]]
|[[#getNeuroDevice|getNeuroDevice]]()
Returns this object
|- valign="top"
|style="color:#0066FF;" |[[SignalSubsystem Class#Android|SignalSubsystem]]
|[[#getSignalSubsystem|getSignalSubsystem]]()
Returns subsystem for SIGNAL device feature
|- valign="top"
|style="color:#0066FF;" |[[NeuroDeviceState Enumeration#Android|NeuroDeviceState]]
|[[#getState|getState]]()
Returns common device state
|- valign="top"
|style="color:#0066FF;" |[[StimulationSubsystem Class#Android|StimulationSubsystem]]
|[[#getStimulationSubsystem|getStimulationSubsystem]]()
Returns subsystem for STIMUL device feature
|}

==Field Detail==
<h3>deviceStateChanged</h3>
<code><span style="color:#0066FF;">'''public final'''</span> [[SubscribersNotifier Class|SubscribersNotifier]]&lt;[[NeuroDeviceState Enumeration|NeuroDeviceState]]&gt; deviceStateChanged</code>

Subscribe this event to get notifications about device state

==Constructor Detail==

<h3>NeuroDevice</h3>
<code><span style="color:#0066FF;">'''public'''</span> NeuroDevice(<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>close</h3>
<code><span style="color:#0066FF;">'''public void'''</span> close()</code>


<h3>getState</h3>
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDeviceState Enumeration|NeuroDeviceState]] getState()</code>

Returns NeuroDevice state
<dl>
<dt><span>Returns:</span></dt>
<dd>Device state</dd>
</dl>

<h3>getError</h3>
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDeviceError Enumeration|NeuroDeviceError]] getError()</code>

Returns error type if device is in error state
<dl>
<dt><span>Returns:</span></dt>
<dd>Error type for device error state</dd>
</dl>

<h3>getName</h3>
<code><span style="color:#0066FF;">'''public'''</span> java.lang.String getName()</code>

<span>'''Description copied from class: '''</span>[[VisualizableDevice Class#getName|VisualizableDevice]]

Returns name of BLE device
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>[[VisualizableDevice Class#getName|VisualizableDevice.getName()]]</code> in class VisualizableDevice</dd>
<dt><span>Returns:</span></dt>
<dd>BLE device name</dd>
</dl>

<h3>getAddress</h3>
<code><span style="color:#0066FF;">'''public'''</span>&nbsp;java.lang.String&nbsp;getAddress()</code>

<span>'''Description copied from class:''' [[VisualizableDevice Class|VisualizableDevice]]</span>

<div class="block">Returns Bluetooth LE MAC address
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>[[VisualizableDevice Class#getDeviceAddress|VisualizableDevice.getAddress()]]</code> in class VisualizableDevice</dd>
<dt><span>Returns:</span></dt>
<dd>device unique address</dd>
</dl>

<h3>getBatteryLevel</h3>
<code><span style="color:#0066FF;">'''public int'''</span> getBatteryLevel()</code>

<span>'''Description copied from class:''' [[VisualizableDevice Class|VisualizableDevice]]</span>

Returns battery state

<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>[[VisualizableDevice Class#getBatteryLevel|VisualizableDevice.getBatteryLevel()]]</code>&nbsp;in class&nbsp;VisualizableDevice</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>battery charge level in percents</dd>
</dl>

<h3>getNeuroDevice</h3>
<code><span style="color:#0066FF;">'''public'''</span> [[NeuroDevice Class|NeuroDevice]]&nbsp;getNeuroDevice()</code>

<span>'''Description copied from class:'''&nbsp;[[VisualizableDevice Class|VisualizableDevice]]</span>
Returns this object. This method is for comapatability with VisualizableDevice class interface, inherited to use NeuroDevice in scopes where VisualizableDevice is needed
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>[[VisualizableDevice Class#getNeuroDevice|VisualizableDevice.getNeuroDevice()]]</code>&nbsp;in class&nbsp;VisualizableDevice</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This NeuroDevice object</dd>
</dl>


<h3>getSignalSubsystem</h3>
<code><span style="color:#0066FF;">'''public'''</span> [[SignalSubsystem Class|SignalSubsystem]]&nbsp;getSignalSubsystem()</code>

Returns subsystem for SIGNAL device feature

<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Signal subsystem of device. Null if is not supported</dd>
</dl>

<h3>getStimulationSubsystem</h3>
<code><span style="color:#0066FF;">'''public'''</span> [[StimulationSubsystem Class|StimulationSubsystem]]&nbsp;getStimulationSubsystem()</code>

Returns subsystem for STIMUL device feature

<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Stimulation subsystem of device. Null if is not supported</dd>
</dl>

<a name="getFeatures--">
<!--   -->
</a>
<ul class="blockList">
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>device feature</dd>
</dl>
</li>
</ul>


<h3>connect</h3>
<code><span style="color:#0066FF;">'''public void'''</span> connect()</code>

Establishes connection with device services

<h3>disconnect</h3>
<code><span style="color:#0066FF;">'''public void'''</span> disconnect()</code>

Disconnects from device