src/vikroutingengine.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2012-2013, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
   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 #ifndef _VIKING_ROUTING_ENGINE_H
  22 #define _VIKING_ROUTING_ENGINE_H
  23
  24 #include <glib.h>
  25
  26 #include "viktrwlayer.h"
  27 #include "coords.h"
  28 #include "download.h"
  29
  30 #include "vikwindow.h"
  31
  32 G_BEGIN_DECLS
  33
  34 #define VIK_ROUTING_ENGINE_TYPE            (vik_routing_engine_get_type ())
  35 #define VIK_ROUTING_ENGINE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_ROUTING_ENGINE_TYPE, VikRoutingEngine))
  36 #define VIK_ROUTING_ENGINE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_ROUTING_ENGINE_TYPE, VikRoutingEngineClass))
  37 #define VIK_IS_ROUTING_ENGINE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_ROUTING_ENGINE_TYPE))
  38 #define VIK_IS_ROUTING_ENGINE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_ROUTING_ENGINE_TYPE))
  39 #define VIK_ROUTING_ENGINE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), VIK_ROUTING_ENGINE_TYPE, VikRoutingEngineClass))
  40
  41
  42 typedef struct _VikRoutingEngine VikRoutingEngine;
  43 typedef struct _VikRoutingEngineClass VikRoutingEngineClass;
  44
  45 struct _VikRoutingEngineClass
  46 {
  47   GObjectClass object_class;
  48   int (*find)(VikRoutingEngine *self, VikTrwLayer *vtl, struct LatLon start, struct LatLon end);
  49   gchar *(*get_cmd_from_directions)(VikRoutingEngine *self, const gchar *start, const gchar *end);
  50   gboolean (*supports_direction)(VikRoutingEngine *self);
  51   int (*refine)(VikRoutingEngine *self, VikTrwLayer *vtl, VikTrack *vt);
  52   gboolean (*supports_refine)(VikRoutingEngine *self);
  53 };
  54
  55 GType vik_routing_engine_get_type ();
  56
  57 struct _VikRoutingEngine {
  58   GObject obj;
  59 };
  60
  61 int vik_routing_engine_find ( VikRoutingEngine *self, VikTrwLayer *vtl, struct LatLon start, struct LatLon end );
  62 int vik_routing_engine_refine ( VikRoutingEngine *self, VikTrwLayer *vtl, VikTrack *vt );
  63 gchar *vik_routing_engine_get_cmd_from_directions ( VikRoutingEngine *self, const gchar *start, const gchar *end );
  64
  65 /* Acessors */
  66 gchar *vik_routing_engine_get_id ( VikRoutingEngine *self );
  67 gchar *vik_routing_engine_get_label ( VikRoutingEngine *self );
  68 gchar *vik_routing_engine_get_format ( VikRoutingEngine *self );
  69
  70 gboolean vik_routing_engine_supports_direction ( VikRoutingEngine *self );
  71 gboolean vik_routing_engine_supports_refine ( VikRoutingEngine *self );
  72
  73 G_END_DECLS
  74
  75 #endif