Changeset 18941 in osm for applications

Timestamp:

2009-12-04T18:44:56+01:00 (15 years ago)

Author:

stoecker

Message:

applied josmbug 4037

Location:

applications/editors/josm/plugins/livegps/src/livegps

Files:

• LiveGpsAcquirer.java (modified) (14 diffs)
• LiveGpsPlugin.java (modified) (1 diff)

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsAcquirer.java

@@ -2 +2 @@
 
 import static org.openstreetmap.josm.tools.I18n.tr;
+
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
 import java.io.BufferedReader;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStreamReader;
@@ -13 +12 @@
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Properties;
-
+
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
-import org.openstreetmap.josm.Main;
 
 public class LiveGpsAcquirer implements Runnable {
@@ -22 +20 @@
     BufferedReader gpsdReader;
     boolean connected = false;
-    String gpsdHost = Main.pref.get("livegps.gpsd.host","localhost");
+    String gpsdHost = Main.pref.get("livegps.gpsd.host", "localhost");
     int gpsdPort = Main.pref.getInteger("livegps.gpsd.port", 2947);
     boolean shutdownFlag = false;
-    private List<PropertyChangeListener> propertyChangeListener = new ArrayList<PropertyChangeListener>();
+    private final List<PropertyChangeListener> propertyChangeListener = new ArrayList<PropertyChangeListener>();
     private PropertyChangeEvent lastStatusEvent;
     private PropertyChangeEvent lastDataEvent;
 
     /**
+     * The LiveGpsSuppressor is queried, if an event shall be suppressed.
+     */
+    private LiveGpsSuppressor suppressor = null;
+
+    /**
+     * separate thread, where the LiveGpsSuppressor executes.
+     */
+    private Thread suppressorThread = null;
+
+    /**
      * Adds a property change listener to the acquirer.
      * @param listener the new listener
      */
     public void addPropertyChangeListener(PropertyChangeListener listener) {
-        if(!propertyChangeListener.contains(listener)) {
+        if (!propertyChangeListener.contains(listener)) {
             propertyChangeListener.add(listener);
         }
@@ -44 +52 @@
      */
     public void removePropertyChangeListener(PropertyChangeListener listener) {
-        if(propertyChangeListener.contains(listener)) {
+        if (propertyChangeListener.contains(listener)) {
             propertyChangeListener.remove(listener);
         }
@@ -52 +60 @@
      * Fire a gps status change event. Fires events with key "gpsstatus" and a {@link LiveGpsStatus}
      * object as value.
+     * The status event may be sent any time.
      * @param status the status.
      * @param statusMessage the status message.
      */
-    public void fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus status, String statusMessage) {
-        PropertyChangeEvent event = new PropertyChangeEvent(this, "gpsstatus", null, new LiveGpsStatus(status, statusMessage));
-        if(!event.equals(lastStatusEvent)) {
+    public void fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus status,
+            String statusMessage) {
+        PropertyChangeEvent event = new PropertyChangeEvent(this, "gpsstatus",
+                null, new LiveGpsStatus(status, statusMessage));
+
+        if (!event.equals(lastStatusEvent)) {
             firePropertyChangeEvent(event);
             lastStatusEvent = event;
@@ -66 +78 @@
      * Fire a gps data change event to all listeners. Fires events with key "gpsdata" and a
      * {@link LiveGpsData} object as values.
+     * This event is only sent, when the suppressor permits it. This
+     * event will cause the UI to re-draw itself, which has some performance penalty,
      * @param oldData the old gps data.
      * @param newData the new gps data.
      */
     public void fireGpsDataChangeEvent(LiveGpsData oldData, LiveGpsData newData) {
-        PropertyChangeEvent event = new PropertyChangeEvent(this, "gpsdata", oldData, newData);
-        if(!event.equals(lastDataEvent)) {
+        PropertyChangeEvent event = new PropertyChangeEvent(this, "gpsdata",
+                oldData, newData);
+
+        if (!event.equals(lastDataEvent) && checkSuppress()) {
             firePropertyChangeEvent(event);
             lastDataEvent = event;
@@ -90 +106 @@
         LiveGpsData oldGpsData = null;
         LiveGpsData gpsData = null;
+
+        initSuppressor();
+
         shutdownFlag = false;
-        while(!shutdownFlag) {
+        while (!shutdownFlag) {
             double lat = 0;
             double lon = 0;
@@ -98 +117 @@
             boolean haveFix = false;
 
-            try
-            {
-                if (!connected)
-                {
+            try {
+                if (!connected) {
                     System.out.println("LiveGps tries to connect to gpsd");
-                    fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.CONNECTING, tr("Connecting"));
+                    fireGpsStatusChangeEvent(
+                            LiveGpsStatus.GpsStatus.CONNECTING,
+                            tr("Connecting"));
                     InetAddress[] addrs = InetAddress.getAllByName(gpsdHost);
-                    for (int i=0; i < addrs.length && gpsdSocket == null; i++) {
+                    for (int i = 0; i < addrs.length && gpsdSocket == null; i++) {
                         try {
                             gpsdSocket = new Socket(addrs[i], gpsdPort);
                             break;
                         } catch (Exception e) {
-                            System.out.println("LiveGps: Could not open connection to gpsd: " + e);
+                            System.out
+                            .println("LiveGps: Could not open connection to gpsd: "
+                                    + e);
                             gpsdSocket = null;
                         }
                     }
 
-                    if (gpsdSocket != null)
-                    {
-                        gpsdReader = new BufferedReader(new InputStreamReader(gpsdSocket.getInputStream()));
-                        gpsdSocket.getOutputStream().write(new byte[] { 'w', 13, 10 });
-                        fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.CONNECTING, tr("Connecting"));
+                    if (gpsdSocket != null) {
+                        gpsdReader = new BufferedReader(new InputStreamReader(
+                                gpsdSocket.getInputStream()));
+                        gpsdSocket.getOutputStream().write(
+                                new byte[] { 'w', 13, 10 });
+                        fireGpsStatusChangeEvent(
+                                LiveGpsStatus.GpsStatus.CONNECTING,
+                                tr("Connecting"));
                         connected = true;
-                    System.out.println("LiveGps: Connected to gpsd");
-                    }
-                }
-
-
-                if(connected) {
+                        System.out.println("LiveGps: Connected to gpsd");
+                    }
+                }
+
+                if (connected) {
                     // <FIXXME date="23.06.2007" author="cdaller">
-                    // TODO this read is blocking if gps is connected but has no fix, so gpsd does not send positions
+                    // TODO this read is blocking if gps is connected but has no
+                    // fix, so gpsd does not send positions
                     String line = gpsdReader.readLine();
                     // </FIXXME>
-                    if (line == null) break;
+                    if (line == null)
+                        break;
                     String words[] = line.split(",");
 
@@ -141 +166 @@
                     for (int i = 1; i < words.length; i++) {
 
-                        if ((words[i].length() < 2) || (words[i].charAt(1) != '=')) {
+                        if ((words[i].length() < 2)
+                                || (words[i].charAt(1) != '=')) {
                             // unexpected response.
                             continue;
@@ -150 +176 @@
                         oldGpsData = gpsData;
                         gpsData = new LiveGpsData();
-                        switch(what) {
+                        switch (what) {
                         case 'O':
                             // full report, tab delimited.
@@ -160 +186 @@
                                     speed = Float.parseFloat(status[9]);
                                     course = Float.parseFloat(status[8]);
-                                    //view.setSpeed(speed);
-                                    //view.setCourse(course);
-                                } catch (NumberFormatException nex) {}
+                                    // view.setSpeed(speed);
+                                    // view.setCourse(course);
+                                } catch (NumberFormatException nex) {
+                                }
                                 haveFix = true;
                             }
@@ -179 +206 @@
                             // not interested
                         }
-                        fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.CONNECTED, tr("Connected"));
+                        fireGpsStatusChangeEvent(
+                                LiveGpsStatus.GpsStatus.CONNECTED,
+                                tr("Connected"));
                         gpsData.setFix(haveFix);
                         if (haveFix) {
-                            //view.setCurrentPosition(lat, lon);
+                            // view.setCurrentPosition(lat, lon);
                             gpsData.setLatLon(new LatLon(lat, lon));
                             gpsData.setSpeed(speed);
@@ -191 +220 @@
                 } else {
                     // not connected:
-                    fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.DISCONNECTED, tr("Not connected"));
-                    try { Thread.sleep(1000); } catch (InterruptedException ignore) {};
-                }
-            } catch(IOException iox) {
+                    fireGpsStatusChangeEvent(
+                            LiveGpsStatus.GpsStatus.DISCONNECTED,
+                            tr("Not connected"));
+                    try {
+                        Thread.sleep(1000);
+                    } catch (InterruptedException ignore) {
+                    }
+                    ;
+                }
+            } catch (IOException iox) {
                 connected = false;
-                if(gpsData != null) {
+                if (gpsData != null) {
                     gpsData.setFix(false);
                     fireGpsDataChangeEvent(oldGpsData, gpsData);
                 }
-                fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.CONNECTION_FAILED, tr("Connection Failed"));
-                try { Thread.sleep(1000); } catch (InterruptedException ignore) {};
+                fireGpsStatusChangeEvent(
+                        LiveGpsStatus.GpsStatus.CONNECTION_FAILED,
+                        tr("Connection Failed"));
+                try {
+                    Thread.sleep(1000);
+                } catch (InterruptedException ignore) {
+                }
+                ;
                 // send warning to layer
 
@@ -207 +248 @@
         }
 
-        fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.DISCONNECTED, tr("Not connected"));
+        fireGpsStatusChangeEvent(LiveGpsStatus.GpsStatus.DISCONNECTED,
+                tr("Not connected"));
         if (gpsdSocket != null) {
             try {
-              gpsdSocket.close();
-              gpsdSocket = null;
-                  System.out.println("LiveGps: Disconnected from gpsd");
+                gpsdSocket.close();
+                gpsdSocket = null;
+                System.out.println("LiveGps: Disconnected from gpsd");
+            } catch (Exception e) {
+                System.out
+                .println("LiveGps: Unable to close socket; reconnection may not be possible");
             }
-            catch (Exception e) {
-              System.out.println("LiveGps: Unable to close socket; reconnection may not be possible");
+        }
+    }
+
+    /**
+     * Initialize the suppressor and start its thread.
+     */
+    private void initSuppressor() {
+        suppressor = new LiveGpsSuppressor();
+        suppressorThread = new Thread(suppressor);
+        suppressorThread.start();
+    }
+
+    public void shutdown() {
+        // shut down the suppressor thread, too.
+        suppressor.shutdown();
+        this.suppressor = null;
+        shutdownFlag = true;
+    }
+
+    /**
+     * Check, if an event may be sent now.
+     * @return true, if an event may be sent.
+     */
+    private boolean checkSuppress() {
+        if (suppressor != null) {
+            if (suppressor.isAllowUpdate()) {
+                return true;
+            } else {
+                return false;
             }
-        }
-    }
-
-    public void shutdown()
-    {
-        shutdownFlag = true;
+        } else {
+            return true;
+        }
     }
 }

applications/editors/josm/plugins/livegps/src/livegps/LiveGpsPlugin.java

@@ -174 +174 @@
     }
 
-
     /**
      * Add a listener for gps events.