The ::gpx::Create is the first command called to process GPX data. It takes the GPX data from either the rawXML parameter if present or from the contents of gpxFilename, and parses it using tdom. It returns a token value that is used by all the other commands.

::gpx::Cleanuptoken

This procedure cleans up resources associated with token. It is strongly recommended that you call this function after you are done with a given GPX file. Not doing so will result in memory not being freed, and if your app calls ::gpx::Create enough times, the memory leak could cause a performance hit...or worse.

::gpx::GetGPXMetadatatoken

This procedure returns a dictionary of the metadata associated with the GPX data identified by token. The format of the metadata dictionary is described below, but keys version and creator will always be present.

::gpx::GetWaypointCounttoken

This procedure returns the number of waypoints defined in the GPX data identified by token.

::gpx::GetAllWaypointstoken

This procedure returns the a list of waypoints defined in the GPX data identified by token. The format of each waypoint item is described below.

::gpx::GetTrackCounttoken

This procedure returns the number of tracks defined in the GPX data identified by token.

::gpx::GetTrackMetadatatoken whichTrack

This procedure returns a dictionary of the metadata associated track number whichTrack (1 based) in the GPX data identified by token. The format of the metadata dictionary is described below.

::gpx::GetTrackPointstoken whichTrack

The procedure returns a list of track points comprising track number whichTrack (1 based) in the GPX data identified by token. The format of the metadata dictionary is described below.

::gpx::GetRouteCounttoken

This procedure returns the number of routes defined in the GPX data identified by token.

::gpx::GetRouteMetadatatoken whichRoute

This procedure returns a dictionary of the metadata associated route number whichRoute (1 based) in the GPX data identified by token. The format of the metadata dictionary is described below.

::gpx::GetRoutePointstoken whichRoute

The procedure returns a list of route points comprising route number whichRoute (1 based) in the GPX data identified by token. The format of the metadata dictionary is described below.

The metadata associated with either the GPX document, a track, a route, a waypoint, a track point or route point is returned in a dictionary. The keys of that dictionary will be whatever optional GPX elements are present. The value for each key depends on the GPX schema for that element. For example, the value for a version key will be a string, while for a link key will be a sub-dictionary with keys href and optionally text and type.

point item

Each item in a track or route list of points consists of a list of three elements: latitude, longitude and metadata dictionary. Latitude and longitude are decimal numbers. The metadata dictionary format is described above. For points in a track, typically there will always be ele (elevation) and time metadata keys.

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category gpx of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation.