org.opentripplanner.graph_builder.module.osm

Class WayPropertySet

java.lang.Object

org.opentripplanner.graph_builder.module.osm.WayPropertySet

public class WayPropertySet
extends Object

Information given to the GraphBuilder about how to assign permissions, safety values, names, etc. to edges based on OSM tags. TODO rename so that the connection with OSM tags is obvious WayPropertyPickers, CreativeNamePickers, SlopeOverridePickers, and SpeedPickers are applied to ways based on how well their OSMSpecifiers match a given OSM way. Generally one OSMSpecifier will win out over all the others based on the number of exact, partial, and wildcard tag matches. See OSMSpecifier for more details on the matching process.

Field Summary

Fields

Modifier and Type	Field and Description
WayPropertySetSource	base
WayProperties	defaultProperties The WayProperties applied to all ways that do not match any WayPropertyPicker.
Float	defaultSpeed The automobile speed for street segments that do not match any SpeedPicker.

Constructor Summary

Constructors

Constructor and Description
WayPropertySet()

Method Summary

Modifier and Type	Method and Description
void	addCreativeNamer(OSMSpecifier spec, CreativeNamer namer)
void	addNote(OSMSpecifier osmSpecifier, NoteProperties properties)
void	addProperties(OSMSpecifier spec, WayProperties properties)
void	addProperties(OSMSpecifier spec, WayProperties properties, boolean mixin)
void	addSpeedPicker(SpeedPicker picker)
void	createNames(String spec, String patternKey)
void	createNotes(String spec, String patternKey, NoteMatcher matcher)
boolean	equals(Object o)
float	getCarSpeedForWay(OSMWithTags way, boolean back) Get the automobile speed, in meters per second, for this way.
HashMap<String,Float>	getCarSpeedLookup() Returns the current car speed lookup hashmap.
I18NString	getCreativeNameForWay(OSMWithTags way)
WayProperties	getDataForWay(OSMWithTags way) Applies the WayProperties whose OSMPicker best matches this way.
Float	getMetersSecondFromSpeed(String speed)
Set<T2<Alert,NoteMatcher>>	getNoteForWay(OSMWithTags way)
boolean	getSlopeOverride(OSMWithTags way)
HashMap<String,WayProperties>	getWayPropertyLookup() Returns the current way property lookup hashmap.
int	hashCode()
void	index() Initializes lookups and indexes for quick lookup of applicable values for way properties and car speeds.
boolean	isSuitableForStreetParking(OSMWay way)
boolean	isSuitableForTNCStop(OSMWay way)
void	setCarSpeed(String spec, float speed)
void	setProperties(String spec, StreetTraversalPermission permission)
void	setProperties(String spec, StreetTraversalPermission permission, double safety, double safetyBack) Note that the safeties here will be adjusted such that the safest street has a safety value of 1, with all others scaled proportionately.
void	setProperties(String spec, StreetTraversalPermission permission, double safety, double safetyBack, boolean mixin)
void	setSlopeOverride(OSMSpecifier spec, boolean override)

Methods inherited from class java.lang.Object

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

Field Detail

defaultSpeed

public Float defaultSpeed

The automobile speed for street segments that do not match any SpeedPicker.

defaultProperties

public WayProperties defaultProperties

The WayProperties applied to all ways that do not match any WayPropertyPicker.

base

public WayPropertySetSource base

Constructor Detail

WayPropertySet

public WayPropertySet()

Method Detail

index

public void index()

Initializes lookups and indexes for quick lookup of applicable values for way properties and car speeds. This function must be called before looking up way properties and car speeds for ways in order for those caches to be properly initialized.

getDataForWay

public WayProperties getDataForWay(OSMWithTags way)

Applies the WayProperties whose OSMPicker best matches this way. In addition, WayProperties that are mixins will have their safety values applied if they match at all.

getWayPropertyLookup

public HashMap<String,WayProperties> getWayPropertyLookup()

Returns the current way property lookup hashmap. Used for testing only.

getCreativeNameForWay

public I18NString getCreativeNameForWay(OSMWithTags way)

getCarSpeedForWay

public float getCarSpeedForWay(OSMWithTags way,
                               boolean back)

Get the automobile speed, in meters per second, for this way. Try to get value from the cache, otherwise calculate and store in cache.

getCarSpeedLookup

public HashMap<String,Float> getCarSpeedLookup()

Returns the current car speed lookup hashmap. Used for testing only.

getNoteForWay

public Set<T2<Alert,NoteMatcher>> getNoteForWay(OSMWithTags way)

getSlopeOverride

public boolean getSlopeOverride(OSMWithTags way)

addProperties

public void addProperties(OSMSpecifier spec,
                          WayProperties properties,
                          boolean mixin)

addProperties

public void addProperties(OSMSpecifier spec,
                          WayProperties properties)

addCreativeNamer

public void addCreativeNamer(OSMSpecifier spec,
                             CreativeNamer namer)

addNote

public void addNote(OSMSpecifier osmSpecifier,
                    NoteProperties properties)

setSlopeOverride

public void setSlopeOverride(OSMSpecifier spec,
                             boolean override)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

addSpeedPicker

public void addSpeedPicker(SpeedPicker picker)

getMetersSecondFromSpeed

public Float getMetersSecondFromSpeed(String speed)

createNames

public void createNames(String spec,
                        String patternKey)

createNotes

public void createNotes(String spec,
                        String patternKey,
                        NoteMatcher matcher)

setProperties

public void setProperties(String spec,
                          StreetTraversalPermission permission)

setProperties

public void setProperties(String spec,
                          StreetTraversalPermission permission,
                          double safety,
                          double safetyBack)

Note that the safeties here will be adjusted such that the safest street has a safety value of 1, with all others scaled proportionately.

setProperties

public void setProperties(String spec,
                          StreetTraversalPermission permission,
                          double safety,
                          double safetyBack,
                          boolean mixin)

setCarSpeed

public void setCarSpeed(String spec,
                        float speed)

isSuitableForTNCStop

public boolean isSuitableForTNCStop(OSMWay way)

isSuitableForStreetParking

public boolean isSuitableForStreetParking(OSMWay way)