Difference between revisions of "NeuroDevice Class"
NateColeman (talk | contribs) (→Fields Summary) |
NateColeman (talk | contribs) (→Related Classes) |
||
Line 6: | Line 6: | ||
==Related Classes== | ==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== | ==Classes hierarchy== |
Revision as of 11:37, 8 August 2017
Contents
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
- ru.neurotech.common.VisualizableDevice
- ru.neurotech.neurodevices.NeuroDevice
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) |
- <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 resourcesvoid
<a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#connect--">connect</a>()
Establishes connection with device servicesvoid
<a href="../../../ru/neurotech/neurodevices/NeuroDevice.html#disconnect--">disconnect</a>()
Disconnect from devicevoid
<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 addressint
<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 featuresjava.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
- <a name="methods.inherited.from.class.java.lang.Object">
</a>
</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 classjava.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
-
- <a name="field.detail">
</a>
</div>