Difference between revisions of "MotionAssistantDevice Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(Android)
Line 4: Line 4:
  
 
<span style="font-size:150%;">'''Class MotionAssistantDevice'''</span>
 
<span style="font-size:150%;">'''Class MotionAssistantDevice'''</span>
 +
 +
==Related Classes==
 +
 +
ru.neurotech.neurodevices.stimulation.[[MotionAssistantDeviceConnector Class|MotionAssistantDeviceConnector]]
 +
 +
ru.neurotech.neurodevices.stimulation.[[MotionAssistantLimb Class|MotionAssistantLimb]]
 +
 +
ru.neurotech.neurodevices.stimulation.[[MotionAssistantParams Class|MotionAssistantParams]]
 +
 +
ru.neurotech.neurodevices.stimulation.[[StimulationParams Class|StimulationParams]]
  
 
==Classes hierarchy==
 
==Classes hierarchy==
Line 18: Line 28:
 
</ul>
 
</ul>
  
<div class="description">
+
==Class definition==
<ul class="blockList">
+
<code><span style="color:#0066FF;">'''public class'''</span> MotionAssistantDevice <span style="color:#0066FF;">'''extends'''</span> [[VisualizableDevice Class|VisualizableDevice]]</code>
<li class="blockList">
+
 
<hr>
+
==Fields Summary==
<br>
+
{| class="wikitable"
<pre>public class <span class="typeNameLabel">MotionAssistantDevice</span>
+
|- style="background-color: #dee3e9;"
extends <a href="../../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></pre>
+
|'''Modifier and Type'''
</li>
+
|'''Field and Description'''
</ul>
+
|- valign="top"
</div>
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;[[MotionAssistantParams Class|MotionAssistantParams]]&gt;
<div class="summary">
+
|[[#motionAssistantParamsChanged|motionAssistantParamsChanged]]
<ul class="blockList">
+
|-  valign="top"
<li class="blockList">
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Boolean&gt;
<!-- =========== FIELD SUMMARY =========== -->
+
|[[#motionAssistantStateChanged|'''motionAssistantStateChanged''']]
<ul class="blockList">
+
|-  valign="top"
<li class="blockList"><a name="field.summary">
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;[[StimulationParams Class|StimulationParams]]&gt;
<!--  -->
+
|[[#stimulationParamsChanged|'''stimulationParamsChanged''']]
</a>
+
|-  valign="top"
<h3>Field Summary</h3>
+
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Boolean&gt;
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+
|[[#stimulationStateChanged|'''stimulationStateChanged''']]
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
+
|}
<tr>
+
 
<th class="colFirst" scope="col">Modifier and Type</th>
+
 
<th class="colLast" scope="col">Field and Description</th>
+
{| class="wikitable"
</tr>
+
|- style="background-color: #dee3e9;"
<tr class="altColor">
+
|'''Fields inherited from class ru.neurotech.common.[[VisualizableDevice Class|VisualizableDevice]]'''
<td class="colFirst"><code><a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a>&lt;<a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantParams.html" title="class in ru.neurotech.neurodevices.stimulation">MotionAssistantParams</a>&gt;</code></td>
+
|-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#motionAssistantParamsChanged">motionAssistantParamsChanged</a></span></code>&nbsp;</td>
+
|[[VisualizableDevice Class#deviceStateChanged|deviceStateChanged]]
</tr>
+
|}
<tr class="rowColor">
+
 
<td class="colFirst"><code><a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a>&lt;java.lang.Boolean&gt;</code></td>
+
 
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#motionAssistantStateChanged">motionAssistantStateChanged</a></span></code>&nbsp;</td>
 
</tr>
 
<tr class="altColor">
 
<td class="colFirst"><code><a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a>&lt;<a href="../../../../ru/neurotech/neurodevices/stimulation/StimulationParams.html" title="class in ru.neurotech.neurodevices.stimulation">StimulationParams</a>&gt;</code></td>
 
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#stimulationParamsChanged">stimulationParamsChanged</a></span></code>&nbsp;</td>
 
</tr>
 
<tr class="rowColor">
 
<td class="colFirst"><code><a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a>&lt;java.lang.Boolean&gt;</code></td>
 
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#stimulationStateChanged">stimulationStateChanged</a></span></code>&nbsp;</td>
 
</tr>
 
</table>
 
<ul class="blockList">
 
<li class="blockList"><a name="fields.inherited.from.class.ru.neurotech.common.VisualizableDevice">
 
<!--  -->
 
</a>
 
<h3>Fields inherited from class&nbsp;ru.neurotech.common.<a href="../../../../ru/neurotech/common/VisualizableDevice.html" title="class in ru.neurotech.common">VisualizableDevice</a></h3>
 
<code><a href="../../../../ru/neurotech/common/VisualizableDevice.html#deviceStateChanged">deviceStateChanged</a></code></li>
 
</ul>
 
</li>
 
</ul>
 
 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
<ul class="blockList">
 
<ul class="blockList">

Revision as of 10:14, 16 March 2017

MotionAssistant Device

Android

ru.neurotech.neurodevices.stimulation

Class MotionAssistantDevice

Related Classes

ru.neurotech.neurodevices.stimulation.MotionAssistantDeviceConnector

ru.neurotech.neurodevices.stimulation.MotionAssistantLimb

ru.neurotech.neurodevices.stimulation.MotionAssistantParams

ru.neurotech.neurodevices.stimulation.StimulationParams

Classes hierarchy

  • java.lang.Object
    • ru.neurotech.common.VisualizableDevice
      • ru.neurotech.neurodevices.stimulation.MotionAssistantDevice

Class definition

public class MotionAssistantDevice extends VisualizableDevice

Fields Summary

Modifier and Type Field and Description
SubscribersNotifier<MotionAssistantParams> motionAssistantParamsChanged
SubscribersNotifier<java.lang.Boolean> motionAssistantStateChanged
SubscribersNotifier<StimulationParams> stimulationParamsChanged
SubscribersNotifier<java.lang.Boolean> stimulationStateChanged


Fields inherited from class ru.neurotech.common.VisualizableDevice
deviceStateChanged


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

    Constructor Summary

    Constructors 
    Constructor and Description
    <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#MotionAssistantDevice-long-">MotionAssistantDevice</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/stimulation/MotionAssistantDevice.html#close--">close</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#doCalibration--">doCalibration</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#finalize--">finalize</a>() 
    java.lang.String <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getAddress--">getAddress</a>()
    Returns Bluetooth LE MAC address
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getAnalyzedAxis--">getAnalyzedAxis</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getBatteryLevel--">getBatteryLevel</a>()
    Returns battery state
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getCurrentAmplitude--">getCurrentAmplitude</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getGyroStartThreshold--">getGyroStartThreshold</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getGyroStopThreshold--">getGyroStopThreshold</a>() 
    <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getLimbForStimulation--">getLimbForStimulation</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getMaxAssistantStimulusDuration--">getMaxAssistantStimulusDuration</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getMinAssistantStimulationPause--">getMinAssistantStimulationPause</a>() 
    boolean <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getMotionAssistantState--">getMotionAssistantState</a>() 
    java.lang.String <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.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/stimulation/MotionAssistantDevice.html#getNeuroDevice--">getNeuroDevice</a>()
    Returns physical device object which this visual device represents
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getPulseDuration--">getPulseDuration</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getPulseFrequency--">getPulseFrequency</a>() 
    int <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getStimulationDuration--">getStimulationDuration</a>() 
    boolean <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#getStimulatorState--">getStimulatorState</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#motionAssistantStart--">motionAssistantStart</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#motionAssistantStop--">motionAssistantStop</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setCurrentAmplitude-int-">setCurrentAmplitude</a>(int amplitude) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setGyroStartThreshold-int-">setGyroStartThreshold</a>(int gyroStart) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setGyroStopThreshold-int-">setGyroStopThreshold</a>(int gyroStop) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setLimbForMotionAssistant-ru.neurotech.neurodevices.stimulation.MotionAssistantLimb-">setLimbForMotionAssistant</a>(<a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> limb) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setMaxAssistantStimulusDuration-int-">setMaxAssistantStimulusDuration</a>(int maxDuration) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setMinAssistantStimulationPause-int-">setMinAssistantStimulationPause</a>(int minPause) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setMotionAssistantParams-int-int-ru.neurotech.neurodevices.stimulation.MotionAssistantLimb-int-int-">setMotionAssistantParams</a>(int gyroStart,
                           int gyroStop,
                           <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> limb,
                           int minStimulationPause,
    
    int maxStimulusDuration)
     
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setPulseDuration-int-">setPulseDuration</a>(int duration) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setPulseFrequency-int-">setPulseFrequency</a>(int frequency) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setStimulationDuration-int-">setStimulationDuration</a>(int stimulDuration) 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#setStimulatorParams-int-int-int-int-">setStimulatorParams</a>(int amplitude,
                      int pulse_duration,
                      int frequency,
    
    int stimul_duration)
     
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#stimulationStart--">stimulationStart</a>() 
    void <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantDevice.html#stimulationStop--">stimulationStop</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="motionAssistantStateChanged"> </a>

      • motionAssistantStateChanged

        public final <a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><java.lang.Boolean> motionAssistantStateChanged

      <a name="stimulationStateChanged"> </a>

      • stimulationStateChanged

        public final <a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><java.lang.Boolean> stimulationStateChanged

      <a name="motionAssistantParamsChanged"> </a>

      • motionAssistantParamsChanged

        public final <a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><<a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantParams.html" title="class in ru.neurotech.neurodevices.stimulation">MotionAssistantParams</a>> motionAssistantParamsChanged

      <a name="stimulationParamsChanged"> </a>

      • stimulationParamsChanged

        public final <a href="../../../../ru/neurotech/common/SubscribersNotifier.html" title="class in ru.neurotech.common">SubscribersNotifier</a><<a href="../../../../ru/neurotech/neurodevices/stimulation/StimulationParams.html" title="class in ru.neurotech.neurodevices.stimulation">StimulationParams</a>> stimulationParamsChanged
    • <a name="constructor.detail"> </a>

      Constructor Detail

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

      • MotionAssistantDevice

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

      Method Detail

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

      • getName

        public java.lang.String getName()
        Description copied from class: <a href="../../../../ru/neurotech/common/VisualizableDevice.html#getName--">VisualizableDevice</a>
        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()
        Description copied from class: <a href="../../../../ru/neurotech/common/VisualizableDevice.html#getBatteryLevel--">VisualizableDevice</a>
        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="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()

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

      • motionAssistantStart

        public void motionAssistantStart()

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

      • motionAssistantStop

        public void motionAssistantStop()

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

      • getMotionAssistantState

        public boolean getMotionAssistantState()

      <a name="setMotionAssistantParams-int-int-ru.neurotech.neurodevices.stimulation.MotionAssistantLimb-int-int-"> </a>

      • setMotionAssistantParams

        public void setMotionAssistantParams(int gyroStart,
                                             int gyroStop,
                                             <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> limb,
                                             int minStimulationPause,
                                             int maxStimulusDuration)

      <a name="setGyroStartThreshold-int-"> </a>

      • setGyroStartThreshold

        public void setGyroStartThreshold(int gyroStart)

      <a name="setGyroStopThreshold-int-"> </a>

      • setGyroStopThreshold

        public void setGyroStopThreshold(int gyroStop)

      <a name="setLimbForMotionAssistant-ru.neurotech.neurodevices.stimulation.MotionAssistantLimb-"> </a>

      • setLimbForMotionAssistant

        public void setLimbForMotionAssistant(<a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> limb)

      <a name="setMinAssistantStimulationPause-int-"> </a>

      • setMinAssistantStimulationPause

        public void setMinAssistantStimulationPause(int minPause)

      <a name="setMaxAssistantStimulusDuration-int-"> </a>

      • setMaxAssistantStimulusDuration

        public void setMaxAssistantStimulusDuration(int maxDuration)

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

      • getGyroStartThreshold

        public int getGyroStartThreshold()

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

      • getGyroStopThreshold

        public int getGyroStopThreshold()

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

      • getLimbForStimulation

        public <a href="../../../../ru/neurotech/neurodevices/stimulation/MotionAssistantLimb.html" title="enum in ru.neurotech.neurodevices.stimulation">MotionAssistantLimb</a> getLimbForStimulation()

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

      • getMinAssistantStimulationPause

        public int getMinAssistantStimulationPause()

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

      • getMaxAssistantStimulusDuration

        public int getMaxAssistantStimulusDuration()

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

      • getAnalyzedAxis

        public int getAnalyzedAxis()

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

      • stimulationStart

        public void stimulationStart()

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

      • stimulationStop

        public void stimulationStop()

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

      • getStimulatorState

        public boolean getStimulatorState()

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

      • doCalibration

        public void doCalibration()

      <a name="setStimulationDuration-int-"> </a>

      • setStimulationDuration

        public void setStimulationDuration(int stimulDuration)

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

      • getStimulationDuration

        public int getStimulationDuration()

      <a name="setStimulatorParams-int-int-int-int-"> </a>

      • setStimulatorParams

        public void setStimulatorParams(int amplitude,
                                        int pulse_duration,
                                        int frequency,
                                        int stimul_duration)

      <a name="setCurrentAmplitude-int-"> </a>

      • setCurrentAmplitude

        public void setCurrentAmplitude(int amplitude)

      <a name="setPulseDuration-int-"> </a>

      • setPulseDuration

        public void setPulseDuration(int duration)

      <a name="setPulseFrequency-int-"> </a>

      • setPulseFrequency

        public void setPulseFrequency(int frequency)

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

      • getCurrentAmplitude

        public int getCurrentAmplitude()

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

      • getPulseDuration

        public int getPulseDuration()

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

      • getPulseFrequency

        public int getPulseFrequency()

</div>

iOS