pt.lsts.neptus.gps

Class GPSConnection

java.lang.Object

pt.lsts.neptus.gps.GPSConnection

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener

public class GPSConnection
extends java.lang.Object
implements java.beans.PropertyChangeListener

This class provides a way for connecting to a GPS device and start listening for GPS events

Author:

ZP

Constructor Summary

Constructors

Constructor and Description
GPSConnection(java.lang.String serialPort, int baudRate) Class constructor - creates a new GPSConnection with the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGPSListener(GPSListener listener) Add a GPSListener to this connection - Every time the GPSState changes, the listeners will be informed
boolean	connect() Activates the connection and start receiving data.
void	disconnect() Closes the current connection with the device.
GPSState	getCurrentState() Returns the current values read by the GPS
void	logReceivedData(java.lang.String logFile)
static void	main(java.lang.String[] args) Unit testing
void	propertyChange(java.beans.PropertyChangeEvent evt) Every time a value of the GPS changes, this method is called
void	removeGPSListener(GPSListener listener) Stop sending events for the given GPSListener
boolean	showConnectionDialog() Presents a dialog with the connection parameters.
void	simulateGPS(java.lang.String gpsLogFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

GPSConnection

public GPSConnection(java.lang.String serialPort,
             int baudRate)

Class constructor - creates a new GPSConnection with the given parameters.

Parameters:

serialPort - The serial port where to listen for the GPS device (Examples: 'COM2', '/dev/ttyS0')

baudRate - The baud rate of the connection (Examples: '9600', '1200')

Method Detail

simulateGPS

public void simulateGPS(java.lang.String gpsLogFile)

logReceivedData

public void logReceivedData(java.lang.String logFile)

connect

public boolean connect()

Activates the connection and start receiving data. If the connection can't be established, a error dialog is presented and false is returned

Returns:

true if the connection could be established or false if an error has occured

disconnect

public void disconnect()

Closes the current connection with the device.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Every time a value of the GPS changes, this method is called

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

addGPSListener

public void addGPSListener(GPSListener listener)

Add a GPSListener to this connection - Every time the GPSState changes, the listeners will be informed

Parameters:

listener - The GPSListener that will be informed of the GPS state changes

removeGPSListener

public void removeGPSListener(GPSListener listener)

Stop sending events for the given GPSListener

Parameters:

listener - The GPSListener that will no longer receive GPS events

showConnectionDialog

public boolean showConnectionDialog()

Presents a dialog with the connection parameters. If the user pressed the 'Cancel' button, this method returns false. If the user pressed 'OK', returns true.

getCurrentState

public GPSState getCurrentState()

Returns the current values read by the GPS

Returns:

the current values read by the GPS in the form of a GPSState object

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Unit testing

Parameters:

args -

Throws:

java.lang.Exception