com.conveyal.r5.analyst.scenario

Class StopSpec

java.lang.Object

com.conveyal.r5.analyst.scenario.StopSpec

All Implemented Interfaces:

Serializable

public class StopSpec
extends Object
implements Serializable

This represents either an existing or a new stop in Modifications when creating or inserting stops into routes. If an ID is specified, an existing stop with that ID is referenced. If no ID is specified, a new stop is created at the specified coordinates. NOTE: either an ID or coodinate should be specified but not both. If an ID is specified, coordinates should remain at their default value of (0,0).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	id
double	lat
double	lon
String	name
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
StopSpec() default constructor for deserialization
StopSpec(double lon, double lat) Create a new stop at a particular location, rather than reusing a stop from the baseline GTFS.
StopSpec(String id) Re-use an existing stop from baseline GTFS data, given a stop ID.

Method Summary

Modifier and Type	Method and Description
int	resolve(TransportNetwork network, Set<String> warnings) Given a specification for a transit stop, which can be a reference to an existing stop or the location and name of a new stop, find or create the stop in the given network.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

id

public String id

name

public String name

lat

public double lat

lon

public double lon

Constructor Detail

StopSpec

public StopSpec(String id)

Re-use an existing stop from baseline GTFS data, given a stop ID. In this case the StopSpec object will have a non-null ID field, but lat and lon remain at their default values of zero.

StopSpec

public StopSpec(double lon,
                double lat)

Create a new stop at a particular location, rather than reusing a stop from the baseline GTFS. In this case the StopSpec object should have a non-zero lat and lon, but should have a null ID.

StopSpec

public StopSpec()

default constructor for deserialization

Method Detail

resolve

public int resolve(TransportNetwork network,
                   Set<String> warnings)

Given a specification for a transit stop, which can be a reference to an existing stop or the location and name of a new stop, find or create the stop in the given network. This should in fact be a protective scenario copy of the network to avoid trashing the original baseline network. TODO maybe make protective copies a subclass of Networks to enforce this typing.

Parameters:

network - the transit network in which to find or create the specified transit stops.

Returns:

the integer index of the new stop within the given network, or -1 if it could not be created.