TAMPEREEN REITTIOPPAAN RAJAPINNAT

Transkriptio

1 TAMPEREEN REITTIOPPAAN RAJAPINNAT

2 NOVO GROUP OYJ LIITE 1. OHJELMISTON KUVAUS 1 (16) SISÄLLYS 1 RAJAPINNAT Yleistä LISÄRAJAPINNAT REITTIOPPAAN TOIMINTOIHIN Geokoodaus Reititys... 2

3 NOVO GROUP OYJ LIITE 1. OHJELMISTON KUVAUS 1 (16) 1 Rajapinnat 1.1 Yleistä Tässä dokumentissa kuvataan Tampereen reittioppaan geokoodaus ja reitityspyynnön rajapinnat. 2 Lisärajapinnat reittioppaan toimintoihin 2.1 Geokoodaus Geokoodaus on suunniteltu siten että se palauttaa aina yhden paikan koordinaatit. Geokoodausta kutsutaan normaalilla http-pyynnöllä, jossa loc muuttujaan määritellään etsityn paikan nimi. Nimessä käytetään urlenkoodausta, toisin sanoen välilyönnin tilalla käytetään plus-merkkiä(+). Geokoodaus käyttää Reittioppaan paikkatietokantaa, jonka paikat ovat KKJ-2 koordinaatistossa. Kanta sisältää pysäkit, kadunimet ja kohteet. Geokoodaus palauttaa löydetyn paikan nimen ja koordinaatit XMLmuodossa. Huomattavaa että järjestelmässä on virheenkorjaus, jolloin voidaan hakea myös puutteellisella hakutermillä.virheenkorjaus toimii parhaiten mikäli käyttäjä kirjoittaa hakutermin kolme-neljä ensimmäistä merkkiä oikein. Esimerkkikutsu: Vastaus: <?xml version="1.0" encoding="iso "?> <LOCATION coordsys="kkj2"> <NAME>Keskustori</NAME> <XCOORD> </XCOORD> <YCOORD> </YCOORD> </LOCATION>

4 NOVO GROUP OYJ LIITE 1. OHJELMISTON KUVAUS 2 (16) 2.2 Reititys Reititysalgoritmia voidaan kutsua koordinaateilla normaalin HTTPpyynnön avulla. Pyynnössä muuttujaan a määritellään lähtöpaikan koordinaatit ja muuttujaan b määränpään koordinaatit. (x ja y erotellaan toisistaan pilkulla). Pyynnössä hakuparametrit erotellaan toisistaan &- merkillä. Lisäksi haussa voidaan määritellä erilaisia reititys parametrejä. - Kellonaika - Päivämäärä - Optimointimetodi - oletus - nopein - vähiten vaihtoja - vähiten kävelyä - Vaihtomarginaali - oletus 2 minuuttia (vaihtojen välillä pitää vähintään olla tämä aika). Sallitut arvot Vaihtosakko - kuinka monta minuuttia jokaisesta vaihdosta sakotetaan - oletus 5 minuuttia. Tämä tarkoittaa että käyttäjä on mielummin viisi minuuttia hitaammin perillä kuin vaihtaisi toiseen bussiin. - Kävelynopeus - hidas (30 m/min) - nopea (70 m/min) - normaali (100 m/min) - Aikamuuttuja - lähtöaika - perilläolo aika - Kuinka monta reittivaihtoehtoa näytetään - Sallitut arvot 1/3/5 Mikäli kaikkia parametrejä ei ole määritetty käytetään Reittioppaan oletusparametrejä näiden osalta.

5 NOVO GROUP OYJ LIITE 1. OHJELMISTON KUVAUS 3 (16) Esimerkkihaku oletuksilla: Esimerkkihaku kaikilla parametreillä: &margin=2&penalty=5&walkspeed=2&timemode=1&show=3 Missä a = lähtöpaikan koordinaatit pilkulla eroteltuna b = määränpäänkoordinaatit pilkulla eroteltuna time = kellonaika date = päivämäärä (YYYYMMDD) optimize = optimointi menetelmä 1 = oletus reitti, painotettu 2 = nopein reitti 3 = vähiten vaihtoja 4 = vähiten kävelyä margin = vaihtomarginaali (oletus 2 min) penalty = vaihtosakko (oletus 5 min) walkspeed = kävelynopeus 1 = hidas (30m/min) 2 = normaali (70m/min) 3 = nopea (100 m/min) timemode = lähtömoodi 1 = lähtöaika haku 2 = perillä aikahaku show = kuinka monta reitti vaihtoehtoa näytetään (oletus 3, max 5) Vastaus: Vastauksen XML-formaatti on selitetty dokumentissa XML-interface.pdf, kappaleessa response. Samassa dokumentissa on myös XML-pyynnön kuvaus, tätä voidaan käyttää myös socket rajapinnan lävitse. Socket rajapinta toimii siten että lähetetään XML-pyyntöjä tiettyyn ip-osoitteeseen ja porttiin. Socket rajapinnan ero HTTP rajapintaan on se, että HTTPrajapintaan on rakennettu monipuolisemmat tarkistukset. Poikkeukset dokumenttiin: - Lenght arvoja HTTP-rajapinta ei osaa vielä laskea. - Samoin aivan kaikkia Tagien parametrejä ei palauteta (esim date, id, mobility).