Difference between revisions of "BfbDeviceConnector Class"

From Neurotech Software Development Kit
Jump to: navigation, search
(Created page with "=Android=")
 
(→‎Android)
Line 1: Line 1:
 
=Android=
 
=Android=
 +
<!-- ======== START OF CLASS DATA ======== -->
 +
<div class="header">
 +
<div class="subTitle">ru.neurotech.neurodevices.bfb</div>
 +
<h2 title="Class BfbDeviceConnector" class="title">Class BfbDeviceConnector</h2>
 +
</div>
 +
<div class="contentContainer">
 +
<ul class="inheritance">
 +
<li>java.lang.Object</li>
 +
<li>
 +
<ul class="inheritance">
 +
<li>ru.neurotech.neurodevices.bfb.BfbDeviceConnector</li>
 +
</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>
 +
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 +
<ul class="blockList">
 +
<li class="blockList"><a name="constructor.summary">
 +
<!--  -->
 +
</a>
 +
<h3>Constructor Summary</h3>
 +
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 +
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 +
<tr>
 +
<th class="colOne" scope="col">Constructor and Description</th>
 +
</tr>
 +
<tr class="altColor">
 +
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#BfbDeviceConnector-android.content.Context-">BfbDeviceConnector</a></span>(android.content.Context&nbsp;context)</code>
 +
<div class="block">Creates new instance of BfbDeviceConnector class with current application context</div>
 +
</td>
 +
</tr>
 +
</table>
 +
</li>
 +
</ul>
 +
<!-- ========== METHOD SUMMARY =========== -->
 +
<ul class="blockList">
 +
<li class="blockList"><a name="method.summary">
 +
<!--  -->
 +
</a>
 +
<h3>Method Summary</h3>
 +
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 +
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 +
<tr>
 +
<th class="colFirst" scope="col">Modifier and Type</th>
 +
<th class="colLast" scope="col">Method and Description</th>
 +
</tr>
 +
<tr id="i0" class="altColor">
 +
<td class="colFirst"><code><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a></code></td>
 +
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#getDeviceByAddress-java.lang.String-">getDeviceByAddress</a></span>(java.lang.String&nbsp;address)</code>
 +
<div class="block">Returns object, representing device with specified address
 +
It is not guaranteed, that this device is currently available</div>
 +
</td>
 +
</tr>
 +
<tr id="i1" class="rowColor">
 +
<td class="colFirst"><code>void</code></td>
 +
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#shutdown--">shutdown</a></span>()</code>
 +
<div class="block">Ends all operations with device searching and frees all resources</div>
 +
</td>
 +
</tr>
 +
<tr id="i2" class="altColor">
 +
<td class="colFirst"><code>void</code></td>
 +
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#startScan-int-">startScan</a></span>(int&nbsp;timeout)</code>
 +
<div class="block">Starts searching for Callibri devices suitable for BFB trainings</div>
 +
</td>
 +
</tr>
 +
<tr id="i3" class="rowColor">
 +
<td class="colFirst"><code>void</code></td>
 +
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#stopScan--">stopScan</a></span>()</code>
 +
<div class="block">Stops device searching</div>
 +
</td>
 +
</tr>
 +
</table>
 +
<ul class="blockList">
 +
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 +
<!--  -->
 +
</a>
 +
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 +
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</div>
 +
<div class="details">
 +
<ul class="blockList">
 +
<li class="blockList">
 +
<!-- ============ FIELD DETAIL =========== -->
 +
<ul class="blockList">
 +
<li class="blockList"><a name="field.detail">
 +
<!--  -->
 +
</a>
 +
<h3>Field Detail</h3>
 +
<a name="deviceFound">
 +
<!--  -->
 +
</a>
 +
<ul class="blockList">
 +
<li class="blockList">
 +
<h4>deviceFound</h4>
 +
<pre>public final&nbsp;ru.neurotech.common.SubscribersNotifier&lt;<a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a>&gt; deviceFound</pre>
 +
<div class="block">Notifies when proper Callibri BFB device been found and initialized</div>
 +
</li>
 +
</ul>
 +
<a name="scanStateChanged">
 +
<!--  -->
 +
</a>
 +
<ul class="blockListLast">
 +
<li class="blockList">
 +
<h4>scanStateChanged</h4>
 +
<pre>public final&nbsp;ru.neurotech.common.SubscribersNotifier&lt;java.lang.Boolean&gt; scanStateChanged</pre>
 +
<div class="block">Notifies about changing device scanning state</div>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 +
<ul class="blockList">
 +
<li class="blockList"><a name="constructor.detail">
 +
<!--  -->
 +
</a>
 +
<h3>Constructor Detail</h3>
 +
<a name="BfbDeviceConnector-android.content.Context-">
 +
<!--  -->
 +
</a>
 +
<ul class="blockListLast">
 +
<li class="blockList">
 +
<h4>BfbDeviceConnector</h4>
 +
<pre>public&nbsp;BfbDeviceConnector(android.content.Context&nbsp;context)</pre>
 +
<div class="block">Creates new instance of BfbDeviceConnector class with current application context</div>
 +
<dl>
 +
<dt><span class="paramLabel">Parameters:</span></dt>
 +
<dd><code>context</code> - Application context</dd>
 +
</dl>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
<!-- ============ METHOD DETAIL ========== -->
 +
<ul class="blockList">
 +
<li class="blockList"><a name="method.detail">
 +
<!--  -->
 +
</a>
 +
<h3>Method Detail</h3>
 +
<a name="startScan-int-">
 +
<!--  -->
 +
</a>
 +
<ul class="blockList">
 +
<li class="blockList">
 +
<h4>startScan</h4>
 +
<pre>public&nbsp;void&nbsp;startScan(int&nbsp;timeout)</pre>
 +
<div class="block">Starts searching for Callibri devices suitable for BFB trainings</div>
 +
<dl>
 +
<dt><span class="paramLabel">Parameters:</span></dt>
 +
<dd><code>timeout</code> - Scan time. Zero for infinity</dd>
 +
</dl>
 +
</li>
 +
</ul>
 +
<a name="stopScan--">
 +
<!--  -->
 +
</a>
 +
<ul class="blockList">
 +
<li class="blockList">
 +
<h4>stopScan</h4>
 +
<pre>public&nbsp;void&nbsp;stopScan()</pre>
 +
<div class="block">Stops device searching</div>
 +
</li>
 +
</ul>
 +
<a name="shutdown--">
 +
<!--  -->
 +
</a>
 +
<ul class="blockList">
 +
<li class="blockList">
 +
<h4>shutdown</h4>
 +
<pre>public&nbsp;void&nbsp;shutdown()</pre>
 +
<div class="block">Ends all operations with device searching and frees all resources</div>
 +
</li>
 +
</ul>
 +
<a name="getDeviceByAddress-java.lang.String-">
 +
<!--  -->
 +
</a>
 +
<ul class="blockListLast">
 +
<li class="blockList">
 +
<h4>getDeviceByAddress</h4>
 +
<pre>public&nbsp;<a href="../../../../ru/neurotech/neurodevices/bfb/BfbDevice.html" title="class in ru.neurotech.neurodevices.bfb">BfbDevice</a>&nbsp;getDeviceByAddress(java.lang.String&nbsp;address)</pre>
 +
<div class="block">Returns object, representing device with specified address
 +
It is not guaranteed, that this device is currently available</div>
 +
<dl>
 +
<dt><span class="paramLabel">Parameters:</span></dt>
 +
<dd><code>address</code> - BTLE device address</dd>
 +
<dt><span class="returnLabel">Returns:</span></dt>
 +
<dd>BfbDevice object</dd>
 +
</dl>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</div>
 +
</div>
 +
<!-- ========= END OF CLASS DATA ========= -->

Revision as of 11:01, 8 August 2017

Android

ru.neurotech.neurodevices.bfb

Class BfbDeviceConnector

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


  • public class <span class="typeNameLabel">BfbDeviceConnector</span>
extends java.lang.Object
    • <a name="field.summary"> </a>

      Field Summary

      Fields 
      Modifier and Type Field and Description
      ru.neurotech.common.SubscribersNotifier<<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#deviceFound">deviceFound</a>
      Notifies when proper Callibri BFB device been found and initialized
      ru.neurotech.common.SubscribersNotifier<java.lang.Boolean> <a href="../../../../ru/neurotech/neurodevices/bfb/BfbDeviceConnector.html#scanStateChanged">scanStateChanged</a>
      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
    • <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
Retrieved from "http://wiki.callibri.com/index.php?title=BfbDeviceConnector_Class&oldid=197"