VikRoutingEngine

VikRoutingEngine — the base class to describe routing engine

Functions

Properties

char * format Read / Write / Construct Only
char * id Read / Write / Construct Only
char * label Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── VikRoutingEngine
        ╰── VikRoutingWebEngine

Description

The VikRoutingEngine class is both the interface and the base class for the hierarchie of routing engines.

Functions

vik_routing_engine_find ()

gboolean
vik_routing_engine_find (VikRoutingEngine *self,
                         VikTrwLayer *vtl,
                         struct LatLon start,
                         struct LatLon end);

Retrieve a route between two coordinates.

Parameters

self

self object

 

start

starting point

 

end

ending point

 

Returns

indicates success or not.


vik_routing_engine_refine ()

gboolean
vik_routing_engine_refine (VikRoutingEngine *self,
                           VikTrwLayer *vtl,
                           VikTrack *vt);

Retrieve a route refining the vt track/route.

A refined route is computed from vt . The route is computed from first trackpoint to last trackpoint, and going via all intermediate trackpoints.

Parameters

self

self object

 

vtl

layer where to create new track

 

vt

the simple route to refine

 

Returns

indicates success or not.


vik_routing_engine_get_url_from_directions ()

gchar *
vik_routing_engine_get_url_from_directions
                               (VikRoutingEngine *self,
                                const gchar *start,
                                const gchar *end);

Compute the URL used with the acquire framework.

Parameters

self

routing engine

 

start

the start direction

 

end

the end direction

 

Returns

the computed URL


vik_routing_engine_get_id ()

gchar *
vik_routing_engine_get_id (VikRoutingEngine *self);

Returns

the id of self


vik_routing_engine_get_label ()

gchar *
vik_routing_engine_get_label (VikRoutingEngine *self);

Returns

the label of self


vik_routing_engine_get_format ()

gchar *
vik_routing_engine_get_format (VikRoutingEngine *self);

GPSbabel's Format of result.

Returns

the format of self


vik_routing_engine_supports_direction ()

gboolean
vik_routing_engine_supports_direction (VikRoutingEngine *self);

Returns

TRUE if this engine supports the route finding based on directions


vik_routing_engine_supports_refine ()

gboolean
vik_routing_engine_supports_refine (VikRoutingEngine *self);

Parameters

self

routing engine

 

Returns

TRUE if this engine supports the refine of track

Types and Values

VIK_ROUTING_ENGINE_TYPE

#define VIK_ROUTING_ENGINE_TYPE            (vik_routing_engine_get_type ())

Property Details

The “format” property

  “format”                   char *

The format of the output (see gpsbabel).

Owner: VikRoutingEngine

Flags: Read / Write / Construct Only

Default value: "<no-set>"


The “id” property

  “id”                       char *

The identifier of the routing engine.

Owner: VikRoutingEngine

Flags: Read / Write / Construct Only

Default value: "<no-set>"


The “label” property

  “label”                    char *

The label of the routing engine.

Owner: VikRoutingEngine

Flags: Read / Write / Construct Only

Default value: "<no-set>"