routing

Documentation

Index

• type Direction
• type DirectionsRequest
• type DirectionsResponse
• type EtaRequest
• type EtaResponse
• type Intersection
• type Maneuver
• type Point
• type RouteRequest
• type RouteResponse
• type RoutingService
  • func NewRoutingService(token string) *RoutingService
  • func (t *RoutingService) Directions(request *DirectionsRequest) (*DirectionsResponse, error)
  • func (t *RoutingService) Eta(request *EtaRequest) (*EtaResponse, error)
  • func (t *RoutingService) Route(request *RouteRequest) (*RouteResponse, error)
• type Waypoint

Types

type Direction

type Direction struct {
	// distance to travel in meters
	Distance float64 `json:"distance"`
	// duration to travel in seconds
	Duration float64 `json:"duration"`
	// human readable instruction
	Instruction string `json:"instruction"`
	// intersections on route
	Intersections []Intersection `json:"intersections"`
	// maneuver to take
	Maneuver *Maneuver `json:"maneuver"`
	// street name or location
	Name string `json:"name"`
	// alternative reference
	Reference string `json:"reference"`
}

type DirectionsRequest

type DirectionsRequest struct {
	// The destination of the journey
	Destination *Point `json:"destination"`
	// The staring point for the journey
	Origin *Point `json:"origin"`
}

type DirectionsResponse

type DirectionsResponse struct {
	// Turn by turn directions
	Directions []Direction `json:"directions"`
	// Estimated distance of the route in meters
	Distance float64 `json:"distance"`
	// Estimated duration of the route in seconds
	Duration float64 `json:"duration"`
	// The waypoints on the route
	Waypoints []Waypoint `json:"waypoints"`
}

type EtaRequest

type EtaRequest struct {
	// The end point for the eta calculation
	Destination *Point `json:"destination"`
	// The starting point for the eta calculation
	Origin *Point `json:"origin"`
	// speed in kilometers
	Speed float64 `json:"speed"`
	// type of transport. Only "car" is supported currently.
	Type string `json:"type"`
}

type EtaResponse

type EtaResponse struct {
	// eta in seconds
	Duration float64 `json:"duration"`
}

type Intersection

type Intersection struct {
	Bearings []float64 `json:"bearings"`
	Location *Point    `json:"location"`
}

type Maneuver

type Maneuver struct {
	Action        string  `json:"action"`
	BearingAfter  float64 `json:"bearingAfter"`
	BearingBefore float64 `json:"bearingBefore"`
	Direction     string  `json:"direction"`
	Location      *Point  `json:"location"`
}

type Point

type Point struct {
	// Lat e.g 52.523219
	Latitude float64 `json:"latitude"`
	// Long e.g 13.428555
	Longitude float64 `json:"longitude"`
}

type RouteRequest

type RouteRequest struct {
	// Point of destination for the trip
	Destination *Point `json:"destination"`
	// Point of origin for the trip
	Origin *Point `json:"origin"`
}

type RouteResponse

type RouteResponse struct {
	// estimated distance in meters
	Distance float64 `json:"distance"`
	// estimated duration in seconds
	Duration float64 `json:"duration"`
	// waypoints on the route
	Waypoints []Waypoint `json:"waypoints"`
}

type RoutingService

type RoutingService struct {
	// contains filtered or unexported fields
}

func NewRoutingService

func NewRoutingService(token string) *RoutingService

func (*RoutingService) Directions

func (t *RoutingService) Directions(request *DirectionsRequest) (*DirectionsResponse, error)

Turn by turn directions from a start point to an end point including maneuvers and bearings

func (*RoutingService) Eta

func (t *RoutingService) Eta(request *EtaRequest) (*EtaResponse, error)

Get the eta for a route from origin to destination. The eta is an estimated time based on car routes

func (*RoutingService) Route

func (t *RoutingService) Route(request *RouteRequest) (*RouteResponse, error)

Retrieve a route as a simple list of gps points along with total distance and estimated duration

type Waypoint

type Waypoint struct {
	// gps point coordinates
	Location *Point `json:"location"`
	// street name or related reference
	Name string `json:"name"`
}