src/viktrack.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef _VIKING_TRACK_H
  23 #define _VIKING_TRACK_H
  24
  25 #include <time.h>
  26 #include <glib.h>
  27
  28 #include "vikcoord.h"
  29
  30 /* todo important: put these in their own header file, maybe.probably also rename */
  31
  32 #define VIK_TRACK(x) ((VikTrack *)(x))
  33 #define VIK_TRACKPOINT(x) ((VikTrackpoint *)(x))
  34
  35 typedef struct _VikTrackpoint VikTrackpoint;
  36 struct _VikTrackpoint {
  37   VikCoord coord;
  38   gboolean newsegment;
  39   gboolean has_timestamp;
  40   time_t timestamp;
  41   gdouble altitude;
  42 };
  43
  44 typedef struct _VikTrack VikTrack;
  45 struct _VikTrack {
  46   GList *trackpoints;
  47   gboolean visible;
  48   gchar *comment;
  49   guint8 ref_count;
  50 };
  51
  52 VikTrack *vik_track_new();
  53 void vik_track_set_comment(VikTrack *wp, const gchar *comment);
  54 void vik_track_ref(VikTrack *tr);
  55 void vik_track_free(VikTrack *tr);
  56 VikTrack *vik_track_copy ( const VikTrack *tr );
  57 void vik_track_set_comment_no_copy(VikTrack *tr, gchar *comment);
  58 VikTrackpoint *vik_trackpoint_new();
  59 void vik_trackpoint_free(VikTrackpoint *tp);
  60 VikTrackpoint *vik_trackpoint_copy(VikTrackpoint *tp);
  61 gdouble vik_track_get_length(const VikTrack *tr);
  62 gdouble vik_track_get_length_including_gaps(const VikTrack *tr);
  63 gulong vik_track_get_tp_count(const VikTrack *tr);
  64 guint vik_track_get_segment_count(const VikTrack *tr);
  65 VikTrack **vik_track_split_into_segments(VikTrack *tr, guint *ret_len);
  66 void vik_track_reverse(VikTrack *tr);
  67
  68 gulong vik_track_get_dup_point_count ( const VikTrack *vt );
  69 void vik_track_remove_dup_points ( VikTrack *vt );
  70
  71 gdouble vik_track_get_max_speed(const VikTrack *tr);
  72 gdouble vik_track_get_average_speed(const VikTrack *tr);
  73
  74 void vik_track_convert ( VikTrack *tr, VikCoordMode dest_mode );
  75 gdouble *vik_track_make_elevation_map ( const VikTrack *tr, guint16 num_chunks );
  76 void vik_track_get_total_elevation_gain(const VikTrack *tr, gdouble *up, gdouble *down);
  77 VikTrackpoint *vik_track_get_closest_tp_by_percentage_dist ( VikTrack *tr, gdouble reldist );
  78 gdouble *vik_track_make_speed_map ( const VikTrack *tr, guint16 num_chunks );
  79 gboolean vik_track_get_minmax_alt ( const VikTrack *tr, gdouble *min_alt, gdouble *max_alt );
  80 void vik_track_marshall ( VikTrack *tr, guint8 **data, guint *len);
  81 VikTrack *vik_track_unmarshall (guint8 *data, guint datalen);
  82
  83 #endif