com.dsi.ant.plugins.antplus.pccbase

Class AsyncScanController.AsyncScanResultDeviceInfo

java.lang.Object

com.dsi.ant.plugins.antplus.pccbase.AsyncScanController.AsyncScanResultDeviceInfo

Enclosing class:

AsyncScanController<T extends AntPluginPcc>

public static class AsyncScanController.AsyncScanResultDeviceInfo
extends java.lang.Object

Contains the data describing a device detected by the scan.

Field Summary

Fields

Modifier and Type	Field and Description
static	CREATOR CREATOR is used by Android parceling system.
static java.lang.String	KEY_DEFAULT_ASYNCSCANRESULTKEY IPC key for bundling this object
java.util.UUID	scanResultInternalIdentifier currently used internally by the plugin service

Constructor Summary

Constructors

Constructor and Description
AsyncScanController.AsyncScanResultDeviceInfo(Parcel in) Parcel constructor
AsyncScanController.AsyncScanResultDeviceInfo(java.util.UUID scanResultIdentifier, AntPluginDeviceDbProvider.DeviceDbDeviceInfo deviceInfo, boolean isAlreadyConnected) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
int	getAntDeviceNumber() Retrieves the deviceNumber of this device.
java.lang.String	getDeviceDisplayName() Retrieves a display friendly name for this device.
boolean	isAlreadyConnected() Returns a value indicating if this device is already connected to the the plugin (being used by other applications).
boolean	isUserPreferredDeviceForPlugin() Returns a value indicating if this device is set as the preferred device for this plugin type in the user's device database.
boolean	isUserRecognizedDevice() Returns a value indicating if this device has been saved to the user's device database.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DEFAULT_ASYNCSCANRESULTKEY

public static final java.lang.String KEY_DEFAULT_ASYNCSCANRESULTKEY

IPC key for bundling this object

See Also:

Constant Field Values

scanResultInternalIdentifier

public final java.util.UUID scanResultInternalIdentifier

currently used internally by the plugin service

CREATOR

public static final  CREATOR

CREATOR is used by Android parceling system.

Constructor Detail

AsyncScanController.AsyncScanResultDeviceInfo

public AsyncScanController.AsyncScanResultDeviceInfo(java.util.UUID scanResultIdentifier,
                                             AntPluginDeviceDbProvider.DeviceDbDeviceInfo deviceInfo,
                                             boolean isAlreadyConnected)

Constructor

Parameters:

scanResultIdentifier - unique identifier within this async scan controller instance

deviceInfo - device information

isAlreadyConnected - true if device is already connected to another application in the plugin service

AsyncScanController.AsyncScanResultDeviceInfo

public AsyncScanController.AsyncScanResultDeviceInfo(Parcel in)

Parcel constructor

Parameters:

in - Parcel with object data

Method Detail

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

getDeviceDisplayName

public java.lang.String getDeviceDisplayName()

Retrieves a display friendly name for this device. This name is the user's saved name if this device is saved in the user's device database, or a generated name if it isn't.

Returns:

The name of the device this PCC is accessing.

getAntDeviceNumber

public int getAntDeviceNumber()

Retrieves the deviceNumber of this device.

Returns:

The ANT channel deviceNumber of the device this PCC is accessing. If the value is negative it means the plugin does not support this function.

isUserRecognizedDevice

public boolean isUserRecognizedDevice()

Returns a value indicating if this device has been saved to the user's device database.

Returns:

True if the device is saved in the user's device database.

isUserPreferredDeviceForPlugin

public boolean isUserPreferredDeviceForPlugin()

Returns a value indicating if this device is set as the preferred device for this plugin type in the user's device database.

Returns:

True if the device is set as the preferred device for this plugin.

isAlreadyConnected

public boolean isAlreadyConnected()

Returns a value indicating if this device is already connected to the the plugin (being used by other applications). Typically, already connected devices still provide the same data to new clients, but may have restrictions on commands that can be sent when being shared.

Returns:

True if the device is already connected to the plugin.