Class TransitNetwork

java.lang.Object

rgu.transport.geospatial.multimodal.TransitNetwork

public final class TransitNetwork
extends Object

A multi-modal transit network. TransitNetwork is thread-safe, however, the builder object is not thread-safe.

Author:

Lee A. Christie

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransitNetwork.Builder	Builder class, instance is obtained from builder().

Field Summary

Fields

Modifier and Type	Field	Description
static final Speed	DEFAULT_CAR_SPEED
static final Speed	DEFAULT_WALK_SPEED

Method Summary

Modifier and Type	Method	Description
static TransitNetwork.Builder	builder()	Creates a builder object from HashTransitNetwork.
static TransitNetwork.Builder	builder(boolean suppressDuplicates)	Creates a builder object from HashTransitNetwork.
static TransitNetwork.Builder	copyAll(Collection<TransitNetwork> networks, BiConsumer<GeoLocation, GeoLocation> edgeConsumer)	Creates a builder by copying the contents of a collection of transit networks.
void	debugDump(File folder)	Deprecated.
boolean	equals(Object obj)	Checks whether this transit network is equal to the other object.
int	hashCode()	A hashcode.
Set<GeoLocation>	locations()
NearestFinder<GeoLocation>	nearestEuclidean()	Deprecated, for removal: This API element is subject to removal in a future version. user nearestStretchedEuclidean(double) or nearestStretchedEuclidean(double)
NearestFinder<GeoLocation>	nearestHaversine()	Returns a neighbour finder based on which location is nearest on the Haversine space.
NearestFinder<GeoLocation>	nearestStretchedEuclidean(double ratio)	Returns a neighbour finder based on which location is nearest on the Euclidean space.
NearestFinder<GeoLocation>	nearestStretchedEuclidean(GeoLocation at)	Returns a neighbour finder based on which location is nearest on the Euclidean space.
List<Trip>	outgoingTrips(GeoLocation from)	Returns a list of Trips which depart from a given location.
static final TransitNetwork	read(ObjectInputStream in)
static final TransitNetwork	read(ObjectInputStream in, BiConsumer<GeoLocation, GeoLocation> consumer, BiConsumer<GeoLocation, GeoLocation> consumerArtificial)
static final TransitNetwork	read(ObjectInputStream in, Predicate<GeoLocation> spatialFilter, BiConsumer<GeoLocation, GeoLocation> consumer, BiConsumer<GeoLocation, GeoLocation> consumerArtificial)
Set<GeoLocation>	roadNeighbours(GeoLocation location)
Set<GeoLocation>	scanForAllTransitPoints()	Returns a list of locations which are departure or arrival points for transit edges.
List<Trip>	scanForIncomingTrips(GeoLocation to)	Returns a list of Trips which arrive at a given location.
NetworkSearcher	searcher()	Returns a search wrapper for this network.
Graph<JourneyState, Duration>	spatialTemporalGraph()
Graph<JourneyState, Duration>	spatialTemporalGraph(boolean freeArtificial)
Graph<JourneyState, Duration>	spatialTemporalGraph(Map<GeoLocation, List<Trip>> extra)
Graph<JourneyState, Duration>	spatialTemporalGraph(Map<GeoLocation, List<Trip>> extra, boolean freeArtificial)
Set<GeoLocation>	transitDeparturePoints()	Returns a list of locations which are departure points for transit edges.
List<Trip>	transitNeighbours(GeoLocation location)
void	write(ObjectOutputStream out)	Saves the transit network to the specified output stream.

Methods inherited from class Object

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

Field Details

DEFAULT_WALK_SPEED

public static final Speed DEFAULT_WALK_SPEED

DEFAULT_CAR_SPEED

public static final Speed DEFAULT_CAR_SPEED

Method Details

searcher

public NetworkSearcher searcher()

Returns a search wrapper for this network.

Returns:

a search wrapper for this network

copyAll

public static TransitNetwork.Builder copyAll(Collection<TransitNetwork> networks,
 BiConsumer<GeoLocation, GeoLocation> edgeConsumer)

Creates a builder by copying the contents of a collection of transit networks.

Parameters:

networks - the networks to copy, not null

edgeConsumer - consumer for edges, can be null if not needed

Returns:

a builder formed from a copy of the given networks

nearestHaversine

public NearestFinder<GeoLocation> nearestHaversine()

Returns a neighbour finder based on which location is nearest on the Haversine space.

Returns:

a nearest finder

nearestEuclidean

@Deprecated(forRemoval=true)
public NearestFinder<GeoLocation> nearestEuclidean()

Deprecated, for removal: This API element is subject to removal in a future version.

user nearestStretchedEuclidean(double) or nearestStretchedEuclidean(double)

Returns a neighbour finder based on which location is nearest on the Euclidean space.

Returns:

a nearest finder

nearestStretchedEuclidean

public NearestFinder<GeoLocation> nearestStretchedEuclidean(double ratio)

Returns a neighbour finder based on which location is nearest on the Euclidean space.

Parameters:

ratio - the stretch ratio, finite, positive

Returns:

a nearest finder

nearestStretchedEuclidean

public NearestFinder<GeoLocation> nearestStretchedEuclidean(GeoLocation at)

Returns a neighbour finder based on which location is nearest on the Euclidean space.

Parameters:

at - the location to used to estimate local curvature

Returns:

a nearest finder

transitDeparturePoints

public Set<GeoLocation> transitDeparturePoints()

Returns a list of locations which are departure points for transit edges.

scanForAllTransitPoints

public Set<GeoLocation> scanForAllTransitPoints()

Returns a list of locations which are departure or arrival points for transit edges. Requires complete scan of all trips.

outgoingTrips

public List<Trip> outgoingTrips(GeoLocation from)

Returns a list of Trips which depart from a given location.

scanForIncomingTrips

public List<Trip> scanForIncomingTrips(GeoLocation to)

Returns a list of Trips which arrive at a given location. Requires complete scan of all trips.

hashCode

public int hashCode()

A hashcode.

Overrides:

hashCode in class Object

Returns:

a hashcode

equals

public boolean equals(Object obj)

Checks whether this transit network is equal to the other object.

Overrides:

equals in class Object

Parameters:

obj - the other object

Returns:

true if equal, false otherwise

builder

public static TransitNetwork.Builder builder()

Creates a builder object from HashTransitNetwork. Builder is not thread-safe.

Returns:

a new builder

builder

public static TransitNetwork.Builder builder(boolean suppressDuplicates)

Creates a builder object from HashTransitNetwork. If suppressDuplicate is set, then no exception will be throw on adding duplicates, instead, the operation will be ignored. Builder is not thread-safe.

Returns:

a new builder

locations

public Set<GeoLocation> locations()

spatialTemporalGraph

public Graph<JourneyState, Duration> spatialTemporalGraph()

spatialTemporalGraph

public Graph<JourneyState, Duration> spatialTemporalGraph(boolean freeArtificial)

spatialTemporalGraph

public Graph<JourneyState, Duration> spatialTemporalGraph(Map<GeoLocation, List<Trip>> extra)

spatialTemporalGraph

public Graph<JourneyState, Duration> spatialTemporalGraph(Map<GeoLocation, List<Trip>> extra,
 boolean freeArtificial)

roadNeighbours

public Set<GeoLocation> roadNeighbours(GeoLocation location)

transitNeighbours

public List<Trip> transitNeighbours(GeoLocation location)

write

public void write(ObjectOutputStream out)
           throws IOException

Saves the transit network to the specified output stream.

Parameters:

out - the output stream, not null

Throws:

IOException - if unable to write the network

read

public static final TransitNetwork read(ObjectInputStream in)
                                 throws IOException

Throws:

IOException

read

public static final TransitNetwork read(ObjectInputStream in,
 BiConsumer<GeoLocation, GeoLocation> consumer,
 BiConsumer<GeoLocation, GeoLocation> consumerArtificial)
                                 throws IOException

Throws:

IOException

read

public static final TransitNetwork read(ObjectInputStream in,
 Predicate<GeoLocation> spatialFilter,
 BiConsumer<GeoLocation, GeoLocation> consumer,
 BiConsumer<GeoLocation, GeoLocation> consumerArtificial)
                                 throws IOException

Throws:

IOException

debugDump

@Deprecated
public void debugDump(File folder)
               throws FileNotFoundException

Deprecated.

Throws:

FileNotFoundException