gpx 0.7 → 0.8.1

data/lib/gpx/magellan_track_log.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006  Doug Fales 
+# Copyright (c) 2006  Doug Fales
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,114 +21,112 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 module GPX
+  # This class will parse the lat/lon and time data from a Magellan track log,
+  # which is a NMEA formatted CSV list of points.
+  class MagellanTrackLog
+    #PMGNTRK
+    # This message is to be used to transmit Track information (basically a list of previous position fixes)
+    # which is often displayed on the plotter or map screen of the unit.  The first field in this message
+    # is the Latitude, followed by N or S.  The next field is the Longitude followed by E or W.  The next
+    # field is the altitude followed by “F” for feet or “M” for meters.  The next field is
+    # the UTC time of the fix.  The next field consists of a status letter of “A” to indicated that
+    # the data is valid, or “V” to indicate that the data is not valid.  The last character field is
+    # the name of the track, for those units that support named tracks.  The last field contains the UTC date
+    # of the fix.  Note that this field is (and its preceding comma) is only produced by the unit when the
+    # command PMGNCMD,TRACK,2 is given.  It is not present when a simple command of PMGNCMD,TRACK is issued.
+
+    #NOTE: The Latitude and Longitude Fields are shown as having two decimal
+    # places. As many additional decimal places may be added as long as the total
+    # length of the message does not exceed 82 bytes.
+
+    # $PMGNTRK,llll.ll,a,yyyyy.yy,a,xxxxx,a,hhmmss.ss,A,c----c,ddmmyy*hh<CR><LF>
+    require 'csv'
+
+    LAT       = 1
+    LAT_HEMI  = 2
+    LON       = 3
+    LON_HEMI  = 4
+    ELE       = 5
+    ELE_UNITS = 6
+    TIME      = 7
+    INVALID_FLAG = 8
+    DATE      = 10
+
+    FEET_TO_METERS = 0.3048
+
+    class << self
+
+      # Takes the name of a magellan file, converts the contents to GPX, and
+      # writes the result to gpx_filename.
+      def convert_to_gpx(magellan_filename, gpx_filename)
+
+        segment = Segment.new
+
+        CSV.open(magellan_filename, "r").each do |row|
+          next if(row.size < 10 or row[INVALID_FLAG] == 'V')
+
+          lat_deg  = row[LAT][0..1]
+          lat_min  = row[LAT][2...-1]
+          lat_hemi = row[LAT_HEMI]
+
+          lat = lat_deg.to_f + (lat_min.to_f / 60.0)
+          lat = (-lat) if(lat_hemi == 'S')
+
+          lon_deg      = row[LON][0..2]
+          lon_min  = row[LON][3..-1]
+          lon_hemi = row[LON_HEMI]
+
+          lon = lon_deg.to_f + (lon_min.to_f / 60.0)
+          lon = (-lon) if(lon_hemi == 'W')
+
+
+          ele = row[ELE]
+          ele_units = row[ELE_UNITS]
+          ele = ele.to_f
+          if(ele_units == 'F')
+            ele *= FEET_TO_METERS
+          end
+
+          hrs  = row[TIME][0..1].to_i
+          mins = row[TIME][2..3].to_i
+          secs = row[TIME][4..5].to_i
+          day  = row[DATE][0..1].to_i
+          mon  = row[DATE][2..3].to_i
+          yr   = 2000 + row[DATE][4..5].to_i
+
+          time = Time.gm(yr, mon, day, hrs, mins, secs)
+
+          #must create point
+          pt = TrackPoint.new(:lat => lat, :lon => lon, :time => time, :elevation => ele)
+          segment.append_point(pt)
+
+        end
+
+        trk = Track.new
+        trk.append_segment(segment)
+        gpx_file = GPXFile.new(:tracks => [trk])
+        gpx_file.write(gpx_filename)
 
-   # This class will parse the lat/lon and time data from a Magellan track log,
-   # which is a NMEA formatted CSV list of points.
-
-   class MagellanTrackLog
-      #PMGNTRK
-      # This message is to be used to transmit Track information (basically a list of previous position fixes) 
-      # which is often displayed on the plotter or map screen of the unit.  The first field in this message 
-      # is the Latitude, followed by N or S.  The next field is the Longitude followed by E or W.  The next 
-      # field is the altitude followed by “F” for feet or “M” for meters.  The next field is 
-      # the UTC time of the fix.  The next field consists of a status letter of “A” to indicated that 
-      # the data is valid, or “V” to indicate that the data is not valid.  The last character field is 
-      # the name of the track, for those units that support named tracks.  The last field contains the UTC date 
-      # of the fix.  Note that this field is (and its preceding comma) is only produced by the unit when the 
-      # command PMGNCMD,TRACK,2 is given.  It is not present when a simple command of PMGNCMD,TRACK is issued.
-
-      #NOTE: The Latitude and Longitude Fields are shown as having two decimal
-      # places. As many additional decimal places may be added as long as the total
-      # length of the message does not exceed 82 bytes.
-
-      # $PMGNTRK,llll.ll,a,yyyyy.yy,a,xxxxx,a,hhmmss.ss,A,c----c,ddmmyy*hh<CR><LF>
-      require 'csv' 
-
-      LAT       = 1
-      LAT_HEMI  = 2
-      LON       = 3
-      LON_HEMI  = 4
-      ELE       = 5 
-      ELE_UNITS = 6
-      TIME      = 7
-      INVALID_FLAG = 8
-      DATE      = 10
-
-      FEET_TO_METERS = 0.3048
-
-      class << self
-
-         # Takes the name of a magellan file, converts the contents to GPX, and
-         # writes the result to gpx_filename.
-         def convert_to_gpx(magellan_filename, gpx_filename)
-
-            segment = Segment.new
-
-            CSV.open(magellan_filename, "r").each do |row| 
-               next if(row.size < 10 or row[INVALID_FLAG] == 'V')
-
-               lat_deg  = row[LAT][0..1]
-               lat_min  = row[LAT][2...-1]
-               lat_hemi = row[LAT_HEMI]
-
-               lat = lat_deg.to_f + (lat_min.to_f / 60.0)
-               lat = (-lat) if(lat_hemi == 'S')
-
-               lon_deg      = row[LON][0..2]
-               lon_min  = row[LON][3..-1]
-               lon_hemi = row[LON_HEMI]
-
-               lon = lon_deg.to_f + (lon_min.to_f / 60.0)
-               lon = (-lon) if(lon_hemi == 'W')
-
-
-               ele = row[ELE]
-               ele_units = row[ELE_UNITS]
-               ele = ele.to_f
-               if(ele_units == 'F')
-                  ele *= FEET_TO_METERS
-               end
-
-               hrs  = row[TIME][0..1].to_i
-               mins = row[TIME][2..3].to_i
-               secs = row[TIME][4..5].to_i
-               day  = row[DATE][0..1].to_i
-               mon  = row[DATE][2..3].to_i
-               yr   = 2000 + row[DATE][4..5].to_i
-
-               time = Time.gm(yr, mon, day, hrs, mins, secs)
-
-               #must create point
-               pt = TrackPoint.new(:lat => lat, :lon => lon, :time => time, :elevation => ele)
-               segment.append_point(pt)
-
-            end 
-
-            trk = Track.new
-            trk.append_segment(segment)
-            gpx_file = GPXFile.new(:tracks => [trk])
-            gpx_file.write(gpx_filename)
-
-         end
-
-         # Tests to see if the given file is a magellan NMEA track log.
-         def is_magellan_file?(filename)
-            i = 0
-            File.open(filename, "r") do |f|
-               f.each do |line|
-                  i +=  1
-                  if line =~ /^\$PMGNTRK/
-                     return true 
-                  elsif line =~ /<\?xml/
-                     return false
-                  elsif(i > 10)
-                     return false 
-                  end
-               end
+      end
+
+      # Tests to see if the given file is a magellan NMEA track log.
+      def is_magellan_file?(filename)
+        i = 0
+        File.open(filename, "r") do |f|
+          f.each do |line|
+            i +=  1
+            if line =~ /^\$PMGNTRK/
+              return true
+            elsif line =~ /<\?xml/
+              return false
+            elsif(i > 10)
+              return false
             end
-            return false
-         end
+          end
+        end
+        return false
       end
+    end
 
-   end
+  end
 end

data/lib/gpx/point.rb

@@ -20,89 +20,73 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
-include Math
 module GPX
-   # The base class for all points.  Trackpoint and Waypoint both descend from this base class.
-   class Point < Base
-      D_TO_R = PI/180.0;
-      attr_accessor :lat, :lon, :time, :elevation, :gpx_file, :speed
-
-      # When you need to manipulate individual points, you can create a Point
-      # object with a latitude, a longitude, an elevation, and a time.  In
-      # addition, you can pass an XML element to this initializer, and the
-      # relevant info will be parsed out.
-      def initialize(opts = {:lat => 0.0, :lon => 0.0, :elevation => 0.0, :time => Time.now } )
-         @gpx_file = opts[:gpx_file]
-         if (opts[:element])
-            elem = opts[:element]
-            @lat, @lon = elem["lat"].to_f, elem["lon"].to_f
-            @latr, @lonr = (D_TO_R * @lat), (D_TO_R * @lon)
-            #'-'? yyyy '-' mm '-' dd 'T' hh ':' mm ':' ss ('.' s+)? (zzzzzz)?
-            @time = (Time.xmlschema(elem.at("time").inner_text) rescue nil)
-            @elevation = elem.at("ele").inner_text.to_f unless elem.at("ele").nil?
-            @speed = elem.at("speed").inner_text.to_f unless elem.at("speed").nil?
-         else
-            @lat = opts[:lat]
-            @lon = opts[:lon]
-            @elevation = opts[:elevation]
-            @time = opts[:time]
-            @speed = opts[:speed]
-         end
+  # The base class for all points.  Trackpoint and Waypoint both descend from this base class.
+  class Point < Base
+    D_TO_R = Math::PI/180.0;
+    attr_accessor :lat, :lon, :time, :elevation, :gpx_file, :speed, :extensions
 
+    # When you need to manipulate individual points, you can create a Point
+    # object with a latitude, a longitude, an elevation, and a time.  In
+    # addition, you can pass an XML element to this initializer, and the
+    # relevant info will be parsed out.
+    def initialize(opts = {:lat => 0.0, :lon => 0.0, :elevation => 0.0, :time => Time.now } )
+      @gpx_file = opts[:gpx_file]
+      if (opts[:element])
+        elem = opts[:element]
+        @lat, @lon = elem["lat"].to_f, elem["lon"].to_f
+        @latr, @lonr = (D_TO_R * @lat), (D_TO_R * @lon)
+        #'-'? yyyy '-' mm '-' dd 'T' hh ':' mm ':' ss ('.' s+)? (zzzzzz)?
+        @time = (Time.xmlschema(elem.at("time").inner_text) rescue nil)
+        @elevation = elem.at("ele").inner_text.to_f unless elem.at("ele").nil?
+        @speed = elem.at("speed").inner_text.to_f unless elem.at("speed").nil?
+        @extensions = elem.at("extensions") unless elem.at("extensions").nil?
+      else
+        @lat = opts[:lat]
+        @lon = opts[:lon]
+        @elevation = opts[:elevation]
+        @time = opts[:time]
+        @speed = opts[:speed]
+        @extensions = opts[:extensions]
       end
 
+    end
 
-      # Returns the latitude and longitude (in that order), separated by the
-      # given delimeter.  This is useful for passing a point into another API
-      # (i.e. the Google Maps javascript API).
-      def lat_lon(delim = ', ')
-        "#{lat}#{delim}#{lon}"
-      end
 
-      # Returns the longitude and latitude (in that order), separated by the
-      # given delimeter.  This is useful for passing a point into another API
-      # (i.e. the Google Maps javascript API).
-      def lon_lat(delim = ', ')
-        "#{lon}#{delim}#{lat}"
-      end
+    # Returns the latitude and longitude (in that order), separated by the
+    # given delimeter.  This is useful for passing a point into another API
+    # (i.e. the Google Maps javascript API).
+    def lat_lon(delim = ', ')
+      "#{lat}#{delim}#{lon}"
+    end
 
-      # Latitude in radians.
-      def latr
-         @latr ||= (@lat * D_TO_R)
-      end
+    # Returns the longitude and latitude (in that order), separated by the
+    # given delimeter.  This is useful for passing a point into another API
+    # (i.e. the Google Maps javascript API).
+    def lon_lat(delim = ', ')
+      "#{lon}#{delim}#{lat}"
+    end
 
-      # Longitude in radians.
-      def lonr
-         @lonr ||= (@lon * D_TO_R)
-      end
+    # Latitude in radians.
+    def latr
+      @latr ||= (@lat * D_TO_R)
+    end
 
-      # Set the latitude (in degrees).
-      def lat=(latitude)
-         @latr = (latitude * D_TO_R)
-         @lat = latitude
-      end
-
-      # Set the longitude (in degrees).
-      def lon=(longitude)
-         @lonr = (longitude * D_TO_R)
-         @lon = longitude
-      end
+    # Longitude in radians.
+    def lonr
+      @lonr ||= (@lon * D_TO_R)
+    end
 
-      # Convert this point to a XML::Node.
-      def to_xml(elem_name = 'trkpt')
-         pt = Node.new(elem_name)
-         pt['lat'] = lat.to_s
-         pt['lon'] = lon.to_s
-         unless time.nil?
-            time_elem = Node.new('time')
-            time_elem << time.xmlschema
-            pt << time_elem
-         end
-         elev = Node.new('ele')
-         elev << elevation
-         pt <<  elev
-         pt
-      end
+    # Set the latitude (in degrees).
+    def lat=(latitude)
+      @latr = (latitude * D_TO_R)
+      @lat = latitude
+    end
 
-   end
+    # Set the longitude (in degrees).
+    def lon=(longitude)
+      @lonr = (longitude * D_TO_R)
+      @lon = longitude
+    end
+  end
 end

data/lib/gpx/route.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006  Doug Fales 
+# Copyright (c) 2006  Doug Fales
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,50 +21,38 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 module GPX
-
-   # A Route in GPX is very similar to a Track, but it is created by a user
-   # from a series of Waypoints, whereas a Track is created by the GPS device
-   # automatically logging your progress at regular intervals.  
-   class Route < Base
-
-      attr_accessor :points, :name, :gpx_file
-
-      # Initialize a Route from a XML::Node.
-      def initialize(opts = {})
-		if(opts[:gpx_file] and opts[:element])
-         rte_element = opts[:element]
-         @gpx_file = opts[:gpx_file]
-         @name = rte_element.at("//name").inner_text
-         @points = []
-         rte_element.search("//rtept").each do |point|
-		   @points << Point.new(:element => point, :gpx_file => @gpx_file)
-         end
-	   else
-		 @points = (opts[:points] or [])
-		 @name = (opts[:name])
-	   end
-
+  # A Route in GPX is very similar to a Track, but it is created by a user
+  # from a series of Waypoints, whereas a Track is created by the GPS device
+  # automatically logging your progress at regular intervals.
+  class Route < Base
+
+    attr_accessor :points, :name, :gpx_file
+
+    # Initialize a Route from a XML::Node.
+    def initialize(opts = {})
+      if(opts[:gpx_file] and opts[:element])
+        rte_element = opts[:element]
+        @gpx_file = opts[:gpx_file]
+        @name = rte_element.at("name").inner_text
+        @points = []
+        rte_element.search("rtept").each do |point|
+          @points << Point.new(:element => point, :gpx_file => @gpx_file)
+        end
+      else
+        @points = (opts[:points] or [])
+        @name = (opts[:name])
       end
 
-      # Delete points outside of a given area.
-      def crop(area)
-         points.delete_if{ |pt| not area.contains? pt }
-      end
-
-      # Delete points within the given area.
-      def delete_area(area)
-         points.delete_if{ |pt| area.contains? pt }
-      end
+    end
 
-      # Convert this Route to a XML::Node.
-      def to_xml
-         rte = Node.new('rte')
-         name_elem = Node.new('name')
-         name_elem <<  name
-         rte <<  name_elem
-         points.each { |rte_pt| rte <<  rte_pt.to_xml('rtept') }
-         rte
-      end
+    # Delete points outside of a given area.
+    def crop(area)
+      points.delete_if{ |pt| not area.contains? pt }
+    end
 
-   end
+    # Delete points within the given area.
+    def delete_area(area)
+      points.delete_if{ |pt| area.contains? pt }
+    end
+  end
 end