org.opentripplanner.scripting.api

Class OtpsSPT

java.lang.Object

org.opentripplanner.scripting.api.OtpsSPT

public class OtpsSPT
extends Object

A shortest-path-tree, the result of a plan request on a router. Example of use (python script):

   router = otp.getRouter()
   req = otp.createRequest()
   req.setDateTime(...)
   spt = router.plan(req)
 

Author:

laurent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OtpsSPT(ShortestPathTree spt, SampleFactory sampleFactory)

Method Summary

Modifier and Type	Method and Description
OtpsEvaluatedIndividual	eval(double lat, double lon) Evaluate the SPT at a given point.
List<OtpsEvaluatedIndividual>	eval(Iterable<OtpsIndividual> population) Evaluate the SPT for a whole population.
OtpsEvaluatedIndividual	eval(OtpsIndividual individual) Evaluate the SPT for a single individual.
OtpsLatLon	getSnappedOrigin() Get the exact location of the origin of the search (from or to place, depending on the arriveBy option).

Methods inherited from class java.lang.Object

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

Constructor Detail

OtpsSPT

protected OtpsSPT(ShortestPathTree spt,
                  SampleFactory sampleFactory)

Method Detail

eval

public OtpsEvaluatedIndividual eval(double lat,
                                    double lon)

Evaluate the SPT at a given point.

Parameters:

lat -

lon -

Returns:

eval

public OtpsEvaluatedIndividual eval(OtpsIndividual individual)

Evaluate the SPT for a single individual.

Parameters:

individual -

Returns:

The evualuated value, or NULL if no evaluation can be done (out of range, non snappable).

eval

public List<OtpsEvaluatedIndividual> eval(Iterable<OtpsIndividual> population)

Evaluate the SPT for a whole population.

Parameters:

population -

Returns:

The list of evualuated values; can be smaller than the population itself as non-evaluated values will not be returned in the list.

getSnappedOrigin

public OtpsLatLon getSnappedOrigin()

Get the exact location of the origin of the search (from or to place, depending on the arriveBy option).

Returns: