org.opentripplanner.scripting.api

Class OtpsPopulation

java.lang.Object

org.opentripplanner.scripting.api.OtpsPopulation

All Implemented Interfaces:

Iterable<OtpsIndividual>

public class OtpsPopulation
extends Object
implements Iterable<OtpsIndividual>

A population is a collection of individuals. Example of use (python script loading a CSV file):

   spt = ...
   pop = otp.loadCSVPopulation('pop.csv', 'lat', 'lon')
   result = spt.eval(pop)
   for r in result:
       print r.getTime()
 

Author:

laurent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OtpsPopulation()
protected	OtpsPopulation(Population population)

Method Summary

Modifier and Type	Method and Description
void	addIndividual(double lat, double lon) Add a new data-less individual to the collection.
void	addIndividual(double lat, double lon, String[] data) Add a new individual with some data attached to it.
protected int	getDataIndex(String dataName)
Iterator<OtpsIndividual>	iterator()
protected static OtpsPopulation	loadFromCSV(String filename, String latColName, String lonColName)
void	setHeaders(String[] headers) Set data header keys.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OtpsPopulation

protected OtpsPopulation()

OtpsPopulation

protected OtpsPopulation(Population population)

Method Detail

setHeaders

public void setHeaders(String[] headers)

Set data header keys. Only useful for population you create yourself programmatically. For CSV population this will be set automatically according to the CSV headers.

Parameters:

headers - The data header, in order. Later used as a key to retrieve individual data value.

getDataIndex

protected int getDataIndex(String dataName)

addIndividual

public void addIndividual(double lat,
                          double lon)

Add a new data-less individual to the collection.

Parameters:

lat - Latitude of the individual location

lon - Longitude of the individual location

addIndividual

public void addIndividual(double lat,
                          double lon,
                          String[] data)

Add a new individual with some data attached to it.

Parameters:

lat - Latitude of the individual location

lon - Longitude of the individual location

data - An array of data to store in the individual

iterator

public Iterator<OtpsIndividual> iterator()

Specified by:

iterator in interface Iterable<OtpsIndividual>

loadFromCSV

protected static OtpsPopulation loadFromCSV(String filename,
                                            String latColName,
                                            String lonColName)
                                     throws IOException

Throws:

IOException