org.opentripplanner.scripting.api

Class OtpsRouter

java.lang.Object

org.opentripplanner.scripting.api.OtpsRouter

public class OtpsRouter
extends Object

A router, as returned by the getRouter function of the OTP script entry point. Example of code (python script):

   # Get the default router
   defRouter = otp.getRouter()
   # Get the router of ID 'paris'
   parisRouter = otp.getRouter('paris')
 

Author:

laurent

Constructor Summary

Constructors

Constructor and Description
OtpsRouter(Router router)

Method Summary

Modifier and Type	Method and Description
OtpsSPT	plan(OtpsRoutingRequest req) Plan a route on the router given the various options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OtpsRouter

public OtpsRouter(Router router)

Method Detail

plan

public OtpsSPT plan(OtpsRoutingRequest req)

Plan a route on the router given the various options.

Parameters:

req - The routing request options (date/time, modes, etc...)

Returns:

A Shortest-path-tree (a time+various states for each vertices around the origin/destination).