Difference between revisions of "BfbDeviceConnector Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(Android)
(Android)
Line 1: Line 1:
 
=Android=
 
=Android=
<!-- ======== START OF CLASS DATA ======== -->
+
 
<div class="header">
+
ru.neurotech.neurodevices.bfb
<div class="subTitle">ru.neurotech.neurodevices.bfb</div>
+
 
<h2 title="Class BfbDeviceConnector" class="title">Class BfbDeviceConnector</h2>
+
<span style="font-size:150%;">'''Class BfbDeviceConnector'''</span>
</div>
+
 
<div class="contentContainer">
+
==Related Classes==
<ul class="inheritance">
+
 
 +
ru.neurotech.neurodevices.bfb.[[BfbDevice Class|BfbDevice]]
 +
 
 +
ru.neurotech.neurodevices.bfb.[[BfbIndex Class|BfbIndex]]
 +
 
 +
==Classes hierarchy==
 +
<ul>
 
<li>java.lang.Object</li>
 
<li>java.lang.Object</li>
<li>
+
 
<ul class="inheritance">
+
<ul>
<li>ru.neurotech.neurodevices.bfb.BfbDeviceConnector</li>
+
<li>ru.neurotech.neurodevices.bfb.'''BfbDeviceConnector'''</li>
 
</ul>
 
</ul>
</li>
 
</ul>
 
<div class="description">
 
<ul class="blockList">
 
<li class="blockList">
 
<hr>
 
<br>
 
<pre>public class <span class="typeNameLabel">BfbDeviceConnector</span>
 
extends java.lang.Object</pre>
 
</li>
 
</ul>
 
</div>
 
<div class="summary">
 
<ul class="blockList">
 
<li class="blockList">
 
<!-- =========== FIELD SUMMARY =========== -->
 
<ul class="blockList">
 
<li class="blockList"><a name="field.summary">
 
<!--  -->
 
</a>
 
<h3>Field Summary</h3>
 
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 
<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>
 
</tr>
 
<tr class="altColor">
 
<td class="colFirst"><code>ru.neurotech.common.SubscribersNotifier&lt;<a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a>&gt;</code></td>
 
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#deviceFound">deviceFound</a></span></code>
 
<div class="block">Notifies when proper Callibri BFB device been found and initialized</div>
 
</td>
 
</tr>
 
<tr class="rowColor">
 
<td class="colFirst"><code>ru.neurotech.common.SubscribersNotifier&lt;java.lang.Boolean&gt;</code></td>
 
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#scanStateChanged">scanStateChanged</a></span></code>
 
<div class="block">Notifies about changing device scanning state</div>
 
</td>
 
</tr>
 
</table>
 
</li>
 
 
</ul>
 
</ul>
 +
 +
==Class definition==
 +
<code><span style="color:#0066FF;">'''public class'''</span> BfbDeviceConnector <span style="color:#0066FF;">'''extends'''</span> java.lang.Object</code>
 +
 +
==Fields Summary==
 +
{| class="wikitable"
 +
|- style="background-color: #dee3e9;"
 +
|'''Modifier and Type'''
 +
|'''Field and Description'''
 +
|- valign="top"
 +
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;[[BfbDevice Class|BfbDevice]]&gt;
 +
|[[#deviceFound|deviceFound]]
 +
Notifies when proper Callibri BFB device been found and initialized
 +
|-  valign="top"
 +
|[[SubscribersNotifier Class|SubscribersNotifier]]&lt;java.lang.Boolean&gt;
 +
|[[#scanStateChanged|scanStateChanged]]
 +
Notifies about changing device scanning state
 +
|}
 +
 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
<ul class="blockList">
 
<ul class="blockList">

Revision as of 04:19, 9 August 2017

Android

ru.neurotech.neurodevices.bfb

Class BfbDeviceConnector

Related Classes

ru.neurotech.neurodevices.bfb.BfbDevice

ru.neurotech.neurodevices.bfb.BfbIndex

Classes hierarchy

  • java.lang.Object
    • ru.neurotech.neurodevices.bfb.BfbDeviceConnector

Class definition

public class BfbDeviceConnector extends java.lang.Object

Fields Summary

Modifier and Type Field and Description
SubscribersNotifier<BfbDevice> deviceFound

Notifies when proper Callibri BFB device been found and initialized

SubscribersNotifier<java.lang.Boolean> scanStateChanged

Notifies about changing device scanning state

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

    Constructor Summary

    Constructors 
    Constructor and Description
    <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#BfbDeviceConnector-android.content.Context-">BfbDeviceConnector</a>(android.content.Context context)
    Creates new instance of BfbDeviceConnector class with current application context
  • <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
    <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a> <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#getDeviceByAddress-java.lang.String-">getDeviceByAddress</a>(java.lang.String address)
    Returns object, representing device with specified address It is not guaranteed, that this device is currently available
    void <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#shutdown--">shutdown</a>()
    Ends all operations with device searching and frees all resources
    void <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#startScan-int-">startScan</a>(int timeout)
    Starts searching for Callibri devices suitable for BFB trainings
    void <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#stopScan--">stopScan</a>()
    Stops device searching
    • <a name="methods.inherited.from.class.java.lang.Object"> </a>

      Methods inherited from class java.lang.Object

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

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

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

      Field Detail

      <a name="deviceFound"> </a>

      • deviceFound

        public final ru.neurotech.common.SubscribersNotifier<<a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a>> deviceFound
        Notifies when proper Callibri BFB device been found and initialized

      <a name="scanStateChanged"> </a>

      • scanStateChanged

        public final ru.neurotech.common.SubscribersNotifier<java.lang.Boolean> scanStateChanged
        Notifies about changing device scanning state
    • <a name="constructor.detail"> </a>

      Constructor Detail

      <a name="BfbDeviceConnector-android.content.Context-"> </a>

      • BfbDeviceConnector

        public BfbDeviceConnector(android.content.Context context)
        Creates new instance of BfbDeviceConnector class with current application context
        Parameters:
        context - Application context
    • <a name="method.detail"> </a>

      Method Detail

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

      • startScan

        public void startScan(int timeout)
        Starts searching for Callibri devices suitable for BFB trainings
        Parameters:
        timeout - Scan time. Zero for infinity

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

      • stopScan

        public void stopScan()
        Stops device searching

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

      • shutdown

        public void shutdown()
        Ends all operations with device searching and frees all resources

      <a name="getDeviceByAddress-java.lang.String-"> </a>

      • getDeviceByAddress

        public <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a> getDeviceByAddress(java.lang.String address)
        Returns object, representing device with specified address It is not guaranteed, that this device is currently available
        Parameters:
        address - BTLE device address
        Returns:
        BfbDevice object

</div>