org.opentripplanner.scripting.api

Class OtpsIndividual

java.lang.Object

org.opentripplanner.scripting.api.OtpsIndividual

public class OtpsIndividual
extends Object

An individual is a point with coordinates, associated with some optional values (string, floats, integers...)

Author:

laurent

Field Summary

Fields

Modifier and Type	Field and Description
protected Sample	cachedSample
protected String[]	data
protected Graph	graph
protected boolean	isSampleSet
protected double	lat
protected double	lon
protected OtpsPopulation	population

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OtpsIndividual(double lat, double lon, String[] data, OtpsPopulation population)

Method Summary

Modifier and Type	Method and Description
protected OtpsEvaluatedIndividual	eval(ShortestPathTree spt, SampleFactory sampleFactory)
Double	getFloatData(String dataName) Retrieve some data associated with this individual.
Double	getFloatData(String dataName, double def) Retrieve some data associated with this individual.
OtpsLatLon	getLocation()
OtpsLatLon	getSnappedLocation()
String	getStringData(String dataName) Retrieve some data associated with this individual.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

lon

protected double lon

lat

protected double lat

data

protected String[] data

isSampleSet

protected boolean isSampleSet

cachedSample

protected Sample cachedSample

graph

protected Graph graph

population

protected OtpsPopulation population

Constructor Detail

OtpsIndividual

protected OtpsIndividual(double lat,
                         double lon,
                         String[] data,
                         OtpsPopulation population)

Method Detail

getLocation

public OtpsLatLon getLocation()

Returns:

The original location (lat/lon) of the individual, as created or loaded from input data.

getSnappedLocation

public OtpsLatLon getSnappedLocation()

Returns:

The snapped location of the individual on the graph (ie a point on the nearest walkable/drivable street). This can be useful to output a more precise location for a generated grid point, as the returned location is the effective one used for path/time computations. Return NULL if the individual has never been evualuated (by a call to OtpsSPT.eval). Return the original location if the point can't be snapped (too far away from a street).

getStringData

public String getStringData(String dataName)

Retrieve some data associated with this individual.

Parameters:

dataName - The name of the data. For CSV population, this is the name of the column header (case sensitive).

Returns:

The data as a string.

getFloatData

public Double getFloatData(String dataName)

Retrieve some data associated with this individual.

Parameters:

dataName - The name of the data. For CSV population, this is the name of the column header (case sensitive).

Returns:

The data as a float. Return NULL if the data is empty. Throw a NumberFormatException if the data can't be translated from a string.

getFloatData

public Double getFloatData(String dataName,
                           double def)

Retrieve some data associated with this individual.

Parameters:

dataName - The name of the data. For CSV population, this is the name of the column header (case sensitive).

def - The default value in case the data is empty.

Returns:

The data as a float. Return def if the data is empty. Throw a NumberFormatException if the data can't be translated from a string.

eval

protected OtpsEvaluatedIndividual eval(ShortestPathTree spt,
                                       SampleFactory sampleFactory)

toString

public String toString()

Overrides:

toString in class Object