com.partnersoft.gps

Interface GPSDevice

All Known Implementing Classes:

AbstractGPSDevice, NmeaGps, SimulatedGpsDevice

public interface GPSDevice

Author:

Russell Cagle Copyright 2006 Partner Software, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGPSListener(GPSListener listener)
void	close() Close the GPS.
javax.swing.JPanel	getConfigutron() Returns a property page for configuring the GPS.
java.lang.String	getDeviceLabel()
java.lang.String	getDeviceType()
GPSState	getGpsState() Returns null if the GPS is not open.
Postprocessing	getPostprocessing()
boolean	isOpen()
void	open() Open the GPS using the current settings.
void	removeAllListeners() Drops all listeners.
void	removeGPSListener(GPSListener listener)
SurveyedLocation	surveyLocation() Called by MapEditLogic to survey a GPS location, which then gets passed in to MapEditActor through the MapEditContext.

Method Detail

addGPSListener

void addGPSListener(GPSListener listener)

removeGPSListener

void removeGPSListener(GPSListener listener)

getDeviceType

java.lang.String getDeviceType()

getDeviceLabel

java.lang.String getDeviceLabel()

open

void open()
          throws java.io.IOException

Open the GPS using the current settings. If this throws IOException, the GPS should be in the 'closed' state.

Throws:

java.io.IOException

close

void close()

Close the GPS.

isOpen

boolean isOpen()

Returns:

true if the GPS is open.

getGpsState

GPSState getGpsState()

Returns null if the GPS is not open.

Returns:

getConfigutron

javax.swing.JPanel getConfigutron()

Returns a property page for configuring the GPS.

Returns:

surveyLocation

SurveyedLocation surveyLocation()

Called by MapEditLogic to survey a GPS location, which then gets passed in to MapEditActor through the MapEditContext. Basically here so that the TrimbleDevice has the opportunity to throw up the CollectTrimbleDialog.

If it returns null, there is no reading available. In the case of the Trimble GPS, the user may have cancelled collecting.

The SurveyedLocation has a field for the GPS ID, which can be filled in if the GPSDevice implementation is doing post-processing.

Returns:

getPostprocessing

Postprocessing getPostprocessing()

removeAllListeners

void removeAllListeners()

Drops all listeners. Used by headless map app shutdown.