brian d foy > Palm-Magellan-NavCompanion-0.53 > Palm::Magellan::NavCompanion

Download:
Palm-Magellan-NavCompanion-0.53.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.53   Source  

NAME ^

Palm::Magellan::NavCompanion - access the Magellan GPS Companion waypoints file

SYNOPSIS ^

        use Palm::Magellan::NavCompanion;

        my $pdb = Palm::Magellan::NavCompanion->new;
        $pdb->Load( $file );

        my $waypoints = $pdb->{records};

        $, = ", ";
        foreach my $wp ( @$waypoints )
                {
                print $wp->name, $wp->latitude, $wp->longitude;
                print "\n";
                }

DESCRIPTION ^

This module gives you access to the waypoints in the Magellan's GPS Companion "Companion Waypoints.pdb" file. You have to be able to load that file, which probably means that you have it on your computer rather than your Palm. On my machine, this file shows up in the Palm directory as Palm/Users/..user../Backups/Companion Waypoints.pdb .

Behind-the-scenes, Palm::PDB does all the work, so this module has part of its interface and data structure. For instance, the Load() method accesses and parses the file and returns the general data structure that Palm::PDB creates. The interesting bits (the waypoints) is an anonymous array which is the value for the key records.

        # an anonymous array
        my $waypoints = $pdb->{records};

Each element in @{ $waypoints } is an object of class Palm::Magellan::NavCompanion::Record, which is really just a class of accessor methods (for now).

Methods

new

Create a new object. This method takes no arguments

Load( FILENAME )

Load a file in Palm Database format

name

The description. The format allows up to 20 characters.

description

The description. The format allows up to 32 characters.

elevation

The altitude, in meters

latitude

The latitude, as a decimal number. Positive numbers are north latitude and negative numbers are south latitude.

longitude

The longitude, as a decimal number. Positive numbers are east longitude and negative numbers are west longitude.

creation_date

The creation date of the waypoint, in the format MM/DD/YYYY. This comprises the individual elements found in the database format, which are also available individually.

creation_time

The creation time of the waypoint, in the format HH:MM.ss This comprises the individual elements found in the database format, which are also available individually.

creation_sec

The second the waypoint was created.

creation_min

The minute the waypoint was created.

creation_hour

The hour the waypoint was created.

creation_day

The day the waypoint was created.

creation_mon

The month the waypoint was created.

creation_year

The year the waypoint was created. It includes the century.

TO DO ^

* write records too

SEE ALSO ^

Palm::PDB

SOURCE AVAILABILITY ^

This source is part of a SourceForge project which always has the latest sources in SVN, as well as all of the previous releases.

        http://sourceforge.net/projects/brian-d-foy/

If, for some reason, I disappear from the world, one of the other members of the project can shepherd this module appropriately.

AUTHOR ^

brian d foy <bdfoy@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (c) 2004-2008 brian d foy. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: