Difference between revisions of "NeuroDevice Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(→‎Android)
(→‎Android)
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</div>
−
<h3>Field Detail</h3>
+
 
−
<a name="deviceStateChanged">
 
−
<!--  -->
 
−
</a>
 
−
<ul class="blockListLast">
 
−
<li class="blockList">
 
−
<h4>deviceStateChanged</h4>
 
−
<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>
 
−
</li>
 
−
</ul>
 
−
</li>
 
−
</ul>
 
 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
<ul class="blockList">
 
<ul class="blockList">

Revision as of 05:32, 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</div>

  • <a name="constructor.detail"> </a>

    Constructor Detail

    <a name="NeuroDevice-long-"> </a>

    • NeuroDevice

      public NeuroDevice(long nativeObjPtr)
  • <a name="method.detail"> </a>

    Method Detail

    <a name="finalize--"> </a>

    • finalize

      public void finalize()
              throws java.lang.Throwable
      Overrides:
      finalize in class java.lang.Object
      Throws:
      java.lang.Throwable

    <a name="close--"> </a>

    • close

      public void close()
      Close device and free all resources

    <a name="getState--"> </a>

    • getState

      public <a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a> getState()
      Returns common device state. To get error info call getError method
      Returns:
      device state

    <a name="getError--"> </a>

    • getError

      public <a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceError.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceError</a> getError()
      Returns device error state information
      Returns:
      error type

    <a name="getName--"> </a>

    • getName

      public java.lang.String getName()
      Returns name of BLE device
      Specified by:
      <a href="../../../ru/neurotech/common/VisualizableDevice.html#getName--">getName</a> in class <a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a>
      Returns:
      BLE device name

    <a name="getAddress--"> </a>

    • getAddress

      public java.lang.String getAddress()
      Description copied from class: <a href="../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">VisualizableDevice</a>
      Returns Bluetooth LE MAC address
      Specified by:
      <a href="../../../ru/neurotech/common/VisualizableDevice.html#getAddress--">getAddress</a> in class <a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a>
      Returns:
      device unique address

    <a name="getBatteryLevel--"> </a>

    • getBatteryLevel

      public int getBatteryLevel()
      Returns battery state
      Specified by:
      <a href="../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">getBatteryLevel</a> in class <a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a>
      Returns:
      battery charge level in percents

    <a name="getNeuroDevice--"> </a>

    • getNeuroDevice

      public <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a> getNeuroDevice()
      Description copied from class: <a href="../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">VisualizableDevice</a>
      Returns physical device object which this visual device represents
      Specified by:
      <a href="../../../ru/neurotech/common/VisualizableDevice.html#getNeuroDevice--">getNeuroDevice</a> in class <a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a>
      Returns:
      NeuroDevice of current visual device

    <a name="getSignalSubsystem--"> </a>

    • getSignalSubsystem

      public <a href="../../../ru/neurotech/neurodevices/features/SignalSubsystem.html" title="class in ru.neurotech.neurodevices.features">SignalSubsystem</a> getSignalSubsystem()
      Returns subsystem for SIGNAL device feature
      Returns:
      Signal subsystem of device. Null if is not supported

    <a name="getStimulationSubsystem--"> </a>

    • getStimulationSubsystem

      public <a href="../../../ru/neurotech/neurodevices/features/StimulationSubsystem.html" title="class in ru.neurotech.neurodevices.features">StimulationSubsystem</a> getStimulationSubsystem()

    <a name="getFeatures--"> </a>

    • getFeatures

      public <a href="../../../ru/neurotech/neurodevices/DeviceFeature.html" title="enum in ru.neurotech.neurodevices">DeviceFeature</a>[] getFeatures()
      Returns supported device features
      Returns:
      device feature

    <a name="connect--"> </a>

    • connect

      public void connect()
      Establishes connection with device services

    <a name="disconnect--"> </a>

    • disconnect

      public void disconnect()
      Disconnect from device

</li> </ul> </div> </div>

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