com.esf.device.usb.manager.gps.service

Interface IGpsUsbManagerService

public interface IGpsUsbManagerService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GPS_ATTACHED_TOPIC
static java.lang.String	GPS_DETACHED_TOPIC
static java.lang.String	GPS_PROPERTY_USB_PORT_ADDRESS
static java.lang.String	GPS_PROPERTY_USB_SERIAL_PORT
static java.lang.String	SERVICE_NAME Reports the class name representing this interface.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areDevicesPresent() This method returns whether or not there are any devices currently attached.
java.lang.String[]	getDeviceUsbPorts() Returns an array of Strings that represent the USB port names of the connected devices
java.lang.String	getSerialPort(java.lang.String usbPortNumber) This method returns the serial port that has been assigned to the USB-to-Serial device attached to a specified USB port.
void	registerListener(GpsListener listener) This method registers an GPS Listener to be notified when a device has been attached or detached
void	unregisterListener(GpsListener listener) This method unregisters an GPS Listener

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

GPS_ATTACHED_TOPIC

static final java.lang.String GPS_ATTACHED_TOPIC

See Also:

Constant Field Values

GPS_DETACHED_TOPIC

static final java.lang.String GPS_DETACHED_TOPIC

See Also:

Constant Field Values

GPS_PROPERTY_USB_PORT_ADDRESS

static final java.lang.String GPS_PROPERTY_USB_PORT_ADDRESS

See Also:

Constant Field Values

GPS_PROPERTY_USB_SERIAL_PORT

static final java.lang.String GPS_PROPERTY_USB_SERIAL_PORT

See Also:

Constant Field Values

Method Detail

areDevicesPresent

boolean areDevicesPresent()

This method returns whether or not there are any devices currently attached.

Returns:

True if there are any devices attached, false otherwise.

getDeviceUsbPorts

java.lang.String[] getDeviceUsbPorts()

Returns an array of Strings that represent the USB port names of the connected devices

Returns:

An array of Strings that represent the USB port names of the connected devices

getSerialPort

java.lang.String getSerialPort(java.lang.String usbPortNumber)

This method returns the serial port that has been assigned to the USB-to-Serial device attached to a specified USB port.

Parameters:

usbPortNumber - A String representing the USB port that the device is plugged into.

Returns:

A String representing the serial port that has been assigned to the device. Null if no device is connected to the specified USB port.

registerListener

void registerListener(GpsListener listener)

This method registers an GPS Listener to be notified when a device has been attached or detached

Parameters:

listener - A class implementing the GpsListener interface

unregisterListener

void unregisterListener(GpsListener listener)

This method unregisters an GPS Listener

Parameters:

listener - A class implementing the GpsListener interface