1gpx(n) GPS eXchange Format (GPX) gpx(n)
2______________________________________________________________________________
6
8 gpx - Extracts waypoints, tracks and routes from GPX files
9
11 package require Tcl 8.5
12 package require gpx ?0.9?
14 ::gpx::Create gpxFilename ?rawXML?
16 ::gpx::Cleanup token
18 ::gpx::GetGPXMetadata token
20 ::gpx::GetWaypointCount token
22 ::gpx::GetAllWaypoints token
24 ::gpx::GetTrackCount token
26 ::gpx::GetTrackMetadata token whichTrack
28 ::gpx::GetTrackPoints token whichTrack
30 ::gpx::GetRouteCount token
32 ::gpx::GetRouteMetadata token whichRoute
34 ::gpx::GetRoutePoints token whichRoute
36______________________________________________________________________________
38
40 This module parses and extracts waypoints, tracks, routes and metadata
41 from a GPX (GPS eXchange) file. Both GPX version 1.0 and 1.1 are sup‐
42 ported.
43
45 ::gpx::Create gpxFilename ?rawXML?
46 The ::gpx::Create is the first command called to process GPX
47 data. It takes the GPX data from either the rawXML parameter if
48 present or from the contents of gpxFilename, and parses it using
49 tdom. It returns a token value that is used by all the other
50 commands.
51 ::gpx::Cleanup token
53 This procedure cleans up resources associated with token. It is
54 strongly recommended that you call this function after you are
55 done with a given GPX file. Not doing so will result in memory
56 not being freed, and if your app calls ::gpx::Create enough
57 times, the memory leak could cause a performance hit...or worse.
58 ::gpx::GetGPXMetadata token
60 This procedure returns a dictionary of the metadata associated
61 with the GPX data identified by token. The format of the meta‐
62 data dictionary is described below, but keys version and creator
63 will always be present.
64 ::gpx::GetWaypointCount token
66 This procedure returns the number of waypoints defined in the
67 GPX data identified by token.
68 ::gpx::GetAllWaypoints token
70 This procedure returns the a list of waypoints defined in the
71 GPX data identified by token. The format of each waypoint item
72 is described below.
73 ::gpx::GetTrackCount token
75 This procedure returns the number of tracks defined in the GPX
76 data identified by token.
77 ::gpx::GetTrackMetadata token whichTrack
79 This procedure returns a dictionary of the metadata associated
80 track number whichTrack (1 based) in the GPX data identified by
81 token. The format of the metadata dictionary is described
82 below.
83 ::gpx::GetTrackPoints token whichTrack
85 The procedure returns a list of track points comprising track
86 number whichTrack (1 based) in the GPX data identified by token.
87 The format of the metadata dictionary is described below.
88 ::gpx::GetRouteCount token
90 This procedure returns the number of routes defined in the GPX
91 data identified by token.
92 ::gpx::GetRouteMetadata token whichRoute
94 This procedure returns a dictionary of the metadata associated
95 route number whichRoute (1 based) in the GPX data identified by
96 token. The format of the metadata dictionary is described
97 below.
98 ::gpx::GetRoutePoints token whichRoute
100 The procedure returns a list of route points comprising route
101 number whichRoute (1 based) in the GPX data identified by token.
102 The format of the metadata dictionary is described below.
103
105 metadata dictionary
106 The metadata associated with either the GPX document, a track, a
107 route, a waypoint, a track point or route point is returned in a
108 dictionary. The keys of that dictionary will be whatever
109 optional GPX elements are present. The value for each key
110 depends on the GPX schema for that element. For example, the
111 value for a version key will be a string, while for a link key
112 will be a sub-dictionary with keys href and optionally text and
113 type.
114 point item
116 Each item in a track or route list of points consists of a list
117 of three elements: latitude, longitude and metadata dictionary.
118 Latitude and longitude are decimal numbers. The metadata dictio‐
119 nary format is described above. For points in a track, typically
120 there will always be ele (elevation) and time metadata keys.
121
123 % set token [::gpx::Create myGpxFile.gpx]
124 % set version [dict get [::gpx::GetGPXMetadata $token] version]
125 % set trackCnt [::gpx::GetTrackCount $token]
126 % set firstPoint [lindex [::gpx::GetTrackPoints $token 1] 0]
127 % lassign $firstPoint lat lon ptMetadata
128 % puts "first point in the first track is at $lat, $lon"
129 % if {[dict exists $ptMetadata ele]} {
130 puts "at elevation [dict get $ptMetadata ele] meters"
131 }
132 % ::gpx::Cleanup $token
133
136 [1] GPX: the GPS Exchange Format (http://www.topografix.com/gpx.asp)
137 [2] GPX 1.1 Schema Documentation
139 (http://www.topografix.com/GPX/1/1/)
140 [3] GPX 1.0 Developer's Manual (http://www.topografix.com/gpx_man‐
142 ual.asp)
143
145 Keith Vetter
146
148 This document, and the package it describes, will undoubtedly contain
149 bugs and other problems. Please report such in the category gpx of the
150 Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please also
151 report any ideas for enhancements you may have for either package
152 and/or documentation.
153 When proposing code changes, please provide unified diffs, i.e the out‐
155 put of diff -u.
156 Note further that attachments are strongly preferred over inlined
158 patches. Attachments can be made by going to the Edit form of the
159 ticket immediately after its creation, and then using the left-most
160 button in the secondary navigation bar.
161
163 gps, gpx
164
166 File formats
167
169 Copyright (c) 2010, Keith Vetter <kvetter@gmail.com>
170tcllib 0.9 gpx(n)