Difference between revisions of "NeuroDevice Class"

From Neurotech Software Development Kit
Jump to: navigation, search
Line 1: Line 1:
 
=Android=
 
=Android=
  
−
<div class="header">
+
ru.neurotech.neurodevices
−
<div class="subTitle">ru.neurotech.neurodevices</div>
+
 
−
<h2 title="Class NeuroDevice" class="title">Class NeuroDevice</h2>
+
<span style="font-size: 150%;">'''Class NeuroDevice'''</span>
−
</div>
+
 
−
<div class="contentContainer">
+
==Related Classes==
−
<ul class="inheritance">
+
 
 +
==Classes hierarchy==
 +
<ul>
 
<li>java.lang.Object</li>
 
<li>java.lang.Object</li>
−
<li>
+
 
−
<ul class="inheritance">
+
<ul>
−
<li><a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">ru.neurotech.common.VisualizableDevice</a></li>
+
<li>ru.neurotech.common.[[VisualizableDevice Class|VisualizableDevice]]</li>
−
<li>
+
 
−
<ul class="inheritance">
+
<ul>
−
<li>ru.neurotech.neurodevices.NeuroDevice</li>
+
<li>ru.neurotech.neurodevices.'''NeuroDevice'''</li>
 
</ul>
 
</ul>
−
</li>
 
 
</ul>
 
</ul>
−
</li>
 
 
</ul>
 
</ul>
−
<div class="description">
+
 
−
<ul class="blockList">
+
==Class definition==
−
<li class="blockList">
+
<code><span style="color:#0066FF;">'''public class'''</span> NeuroDevice <span style="color:#0066FF;">'''extends'''</span> [[VisualizableDevice Class|VisualizableDevice]]</code>
−
<hr>
+
 
−
<br>
+
Represents Neurotech™ device on a layer of algorithmic functionality
−
<pre>public class <span class="typeNameLabel">NeuroDevice</span>
+
 
−
extends <a href="../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></pre>
+
Provides signal and misc channels and methods for signal processing and viewing</div>
−
<div class="block">Represents Neurotech™ device on a layer of algorithmic functionality
+
 
−
Provides signal and misc channels and methods for signal processing and viewing</div>
+
 
−
</li>
 
−
</ul>
 
−
</div>
 
−
<div class="summary">
 
−
<ul class="blockList">
 
−
<li class="blockList">
 
 
<!-- =========== FIELD SUMMARY =========== -->
 
<!-- =========== FIELD SUMMARY =========== -->
 
<ul class="blockList">
 
<ul class="blockList">

Revision as of 11:57, 17 March 2017

Android

ru.neurotech.neurodevices

Class NeuroDevice

Related Classes

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>


  • <a name="field.summary"> </a>

    Field Summary

    Fields 
    Modifier and Type Field and Description
    <a href="../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><<a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a>> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#deviceStateChanged">deviceStateChanged</a>
    Subscribe this event to get notifications about device state
  • <a name="constructor.summary"> </a>

    Constructor Summary

    Constructors 
    Constructor and Description
    <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#NeuroDevice-long-">NeuroDevice</a>(long nativeObjPtr) 
  • <a name="method.summary"> </a>

    Method Summary

    All Methods <a href="javascript:show(2);">Instance Methods</a> <a href="javascript:show(8);">Concrete Methods</a> 
    Modifier and Type Method and Description
    void <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#close--">close</a>()
    Close device and free all resources
    void <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#connect--">connect</a>()
    Establishes connection with device services
    void <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#disconnect--">disconnect</a>()
    Disconnect from device
    void <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#finalize--">finalize</a>() 
    java.lang.String <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getAddress--">getAddress</a>()
    Returns Bluetooth LE MAC address
    int <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getBatteryLevel--">getBatteryLevel</a>()
    Returns battery state
    <a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceError.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceError</a> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getError--">getError</a>()
    Returns device error state information
    <a href="../../../ru/neurotech/neurodevices/DeviceFeature.html" title="enum in ru.neurotech.neurodevices">DeviceFeature</a>[] <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getFeatures--">getFeatures</a>()
    Returns supported device features
    java.lang.String <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getName--">getName</a>()
    Returns name of BLE device
    <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html" title="class in ru.neurotech.neurodevices">NeuroDevice</a> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getNeuroDevice--">getNeuroDevice</a>()
    Returns physical device object which this visual device represents
    <a href="../../../ru/neurotech/neurodevices/features/SignalSubsystem.html" title="class in ru.neurotech.neurodevices.features">SignalSubsystem</a> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getSignalSubsystem--">getSignalSubsystem</a>()
    Returns subsystem for SIGNAL device feature
    <a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getState--">getState</a>()
    Returns common device state.
    <a href="../../../ru/neurotech/neurodevices/features/StimulationSubsystem.html" title="class in ru.neurotech.neurodevices.features">StimulationSubsystem</a> <a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#getStimulationSubsystem--">getStimulationSubsystem</a>() 
    • <a name="methods.inherited.from.class.java.lang.Object"> </a>

      Methods inherited from class java.lang.Object

      clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

      Field Detail

      <a name="deviceStateChanged"> </a>

      • deviceStateChanged

        public <a href="../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><<a href="../../../ru/neurotech/neurodevices/state/NeuroDeviceState.html" title="enum in ru.neurotech.neurodevices.state">NeuroDeviceState</a>> deviceStateChanged
        Subscribe this event to get notifications about device state
    • <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

</div>

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