EMAPI.Router

Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie.

Podsumowanie

EMAPI.Router	Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie.
Pola
drivers	{EMAPI.ArrayObjects} Lista kierowców używanych podczas wyznaczania trasy.
vehicles	{EMAPI.ArrayObjects} Lista pojazdów używanych podczas wyznaczania trasy.
wayPoints	{EMAPI.ArrayObjects} Lista punktów trasy.
map	{EMAPI.Map} Mapa, na której mają być wizualizawane trasy.
routeRepresentation	{EMAPI.Router.RouteRepresentation} Reprezentacja i parametry wyznaczonej za pomocą funkcji calculateRoute trasy.
Konstruktory
EMAPI.Router	Konstruktor nowej instancji klasy EMAPI.Router.
Funkcje
destroy	Niszczy obiekt klasy EMAPI.Router.
addWaypoint	Dodaje nowy punkt trasy do listy wayPoints.
setWaypoint	Zmienia położenie punktu trasy.
removeWaypoints	Usuwa wszystkie punkty trasy z listy wayPoints.
removeWaypoint	Usuwa wybrany punkt trasy z listy wayPoints.
swapWaypoint	Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints.
calculateRoute	Oblicza trasę pomiędzy punktami umieszczonymi w liście wayPoints po podaniu wybranego pojazdu, kierowcy i parametrów wyznaczania trasy.

Pola

drivers

{EMAPI.ArrayObjects} Lista kierowców używanych podczas wyznaczania trasy. Jest to tablica obiektów klasy EMAPI.Router.DriverParams zarządzana poprzez obiekt klasy EMAPI.ArrayObjects. Domyślnie zawiera one parametry następujących kierowców reprezentujących typowe zastosowania: Experienced i Unexperienced.

vehicles

{EMAPI.ArrayObjects} Lista pojazdów używanych podczas wyznaczania trasy. Jest to tablica obiektów klasy EMAPI.Router.VehicleParams zarządzana poprzez obiekt klasy EMAPI.ArrayObjects. Domyślnie zawiera one parametry następujących pojazdów reprezentujących typowe zastosowania: Passenger car, Fast passenger car, Transport truck 10t, Transport truck 20t, Delivery truck, Motorcycle, Bicycle i Pedestrian.

wayPoints

{EMAPI.ArrayObjects} Lista punktów trasy. Jest to tablica obiektów klasy EMAPI.Router.WayPoint zarządzana poprzez obiekt klasy EMAPI.ArrayObjects lub funkcjami addWaypoint, setWaypoint, removeWaypoint, removeWaypoints i swapWaypoint. Domyślnie jest pusta.

map

{EMAPI.Map} Mapa, na której mają być wizualizawane trasy.

routeRepresentation

{EMAPI.Router.RouteRepresentation} Reprezentacja i parametry wyznaczonej za pomocą funkcji calculateRoute trasy.

Konstruktory

EMAPI.Router

Konstruktor nowej instancji klasy EMAPI.Router.

Parametry

options

{Object} Obiekt z dodatkowymi parametrami instancji klasy.

Funkcje

destroy

Niszczy obiekt klasy EMAPI.Router.

addWaypoint

Dodaje nowy punkt trasy do listy wayPoints. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:

zdegeokodowaną informację o geograficznym położeniu punktu (routePlanEntryDescription)
kod błędu (result: 0 = ok, 1 = niepoprawny typ punktu, 2 = zabronione położenie punktu)

Parametry

lonLat	{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu trasy.
pointType	{Integer} Typ punktu trasy: 0 = punkt startowy, 1 = punkt przelotowy, 2 = punkt końcowy. Punkt przelotowy dodawany jest zawsze tuż przed końcowym.
callback	{Function} Funkcja obsługi danych geograficznych wskazanego punktu.

setWaypoint

Zmienia położenie punktu trasy. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:

zdegeokodowaną informację o nowym geograficznym położeniu punktu (routePlanEntryDescription)
kod błędu (result: 0 = ok, 1 = niepoprawny indeks punktu, 2 = zabronione położenie punktu)

Parametry

index	{Integer} Indeks punktu trasy w ramach listy wayPoints: 0 = punkt startowy, itd.
lonLat	{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu trasy.
callback	{Function} Funkcja obsługi danych geograficznych wskazanego punktu.

removeWaypoints

Usuwa wszystkie punkty trasy z listy wayPoints. Dane przekazywane do podstawianej w parametrze funkcji zawierają:

kod błędu (result: 0 = ok, 1 = błąd)

Parametry

callback

{Function} Funkcja obsługi wyników.

removeWaypoint

Usuwa wybrany punkt trasy z listy wayPoints. Dane przekazywane do podstawianej w parametrze funkcji zawierają:

kod błędu (result: 0 = ok, 1 = niepoprawny indeks punktu)

Parametry

index	{Integer} Indeks punktu trasy w ramach listy wayPoints.
callback	{Function} Funkcja obsługi wyników.

swapWaypoint

Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints. Dane przekazywane do podstawianej w parametrze funkcji zawierają:

kod błędu (result: 0 = ok, 1 = niepoprawny indeks punktu)

Parametry

firstPointIndex	{Integer} Indeks pierwszego zamienianego punktu trasy w ramach listy wayPoints.
secondPointIndex	{Integer} Indeks drugiego zamienianego punktu trasy w ramach listy wayPoints.

calculateRoute

Oblicza trasę pomiędzy punktami umieszczonymi w liście wayPoints po podaniu wybranego pojazdu, kierowcy i parametrów wyznaczania trasy. Dane przekazywane do podstawianej w ostatnim parametrze funkcji zawierają:

wyniki i raport trasy (routeRepresentation będący obiektem klasy EMAPI.Router.RouteRepresentation)
statystykę użycia różnych typów dróg (roadResults będący tablicą zawierającą dane statystyczne dla każdego typu drogi, tzn. długość, czas i koszty trasy na drogach tego typu, dostępne typy dróg odpowiadają wartościom pola EMAPI.Router.RoadParams.roadType)
kod błędu (result: 0 = ok, 1 = trasa nie została wyznaczona)

Parametry

vehicle	{EMAPI.Router.VehicleParams} Obiekt typu EMAPI.Router.VehicleParams reprezentujący ustawienia związane z pojazdem, który ma być użyty do wyznaczenia trasy.
driver	{EMAPI.Router.DriverParams} Obiekt typu EMAPI.Router.DriverParams reprezentujący ustawienia związane z pojazdem, który ma być użyty do wyznaczenia trasy.
roadType	{Integer} Typ obliczania trasy: 0 = najkrótsza, 1 = najszybsza, 2 = najtańsza.
routeOptions	{Object} Obiekt zawierający opcje wyznaczania trasy w postaci pól logicznych: useDifficulties = true wymusza wykorzystanie utrudnień w ruchu, useFerry = true włącza wykorzystanie promów, useGroundRoad = true włącza wykorzystanie dróg gruntowych.
callback	{Function} Funkcja obsługi rezultatów wyznaczonej trasy.