OsmHighwaySettings

OsmHighwaySettings instance

The OsmHighwaySettings are accessible via the OsmNetworkReaderSettings.highway_settings property. It allows the user to configure the settings specific to OSM entities that are tagged as highway= which means all road based infrastructure including foot ways and cycle paths.

Here the user can choose which types of OSM highways to activate and deactivate in relation to the defaults that are already created based on the country of origin (or global defaults if no country is provided). Further modes can be allowed or disallowed access to specific types of highways in default situations. Of course, if the tagging explicitly allows or disallows access to modes, this takes precedence.

Methods

A OsmHighwaySettings instance exposes the following methods.

Name	Default	Description
`.activate_all_osm_highway_types()`	N/A	Activate all supported OSM highway types
`.activate_osm_highway_types(+)`	N/A	Activate OSM highway types indicated
`.activate_osm_highway_type(+)`	N/A	Activate OSM highway type indicated
`.activate_osm_road_mode(+)`	N/A	Activate indicated OSM road mode
`.add_allowed_highway_modes(+)`	N/A	Add additional allowed OSM modes to OSM highway type as a default
`.collect_allowed_osm_highway_modes(+)`	N/A	Collect the allowed modes for a given OSM highway type
`.deactivate_all_osm_highway_types_except(+)`	N/A	Deactivate all supported OSM highway types except the ones indicated
`.deactivate_all_osm_road_modes_except(+)`	N/A	Deactivate all OSM road modes except the ones indicated
`.deactivate_osm_road_modes(+)`	N/A	Deactivate indicated OSM road modes
`.deactivate_osm_road_mode(+)`	N/A	Deactivate indicated OSM road mode
`.deactivate_osm_highway_type(+)`	N/A	Deactivate OSM highway type
`.get_mapped_osm_road_modes(+)`	N/A	Get the OSM modes that all map to the provided PLANit mode
`.get_mapped_planit_road_mode(+)`	N/A	Get the PLANit predefined mode mapped to the OSM mode provided
`.get_default_speed_limit_by_osm_highway_type(+)`	N/A	Collect the default speed limit (km/h) for a given OSM highway type
`.is_osm_highway_type_deactivated(+)`	N/A	Verify if OSM highway type is deactivated
`.is_osm_highway_type_activated(+)`	N/A	Verify if OSM highway type is activated
`.is_speed_limit_defaults_based_on_urban_area(+)`	`True`	Verify if applied speed limit defaults are based on urban settings
`.overwrite_capacity_max_density_defaults(+)`	N/A	Overwrite the default capacity (pcu/h/lane) max density (pcu/km/lane) for a given OSM highway type
`.set_default_when_osm_highway_type_unsupported(+)`	`tertiary`	default OSM highway type to use when unsupported type is encountered that is not deactivated
`.set_speed_limit_defaults_based_on_urban_area(+)`	`True`	Indicate of speed limit defaults are to be based on urban area or non-urban area defaults

Properties

N/A

Example 1

from planit import *

# create a network converter
planit_instance = Planit()
network_converter = planit_instance.converter_factory.create(ConverterType.NETWORK)

# example Open Street Map (OSM) network reader        
osm_reader = network_converter.create_reader(NetworkReaderType.OSM, "<country_name>")
osm_reader.settings.set_input_file("<path_to_input_file>")

# indicate to activate all supported OSM highway types for parsing a detailed network
osm_reader.settings.highway_settings.activate_all_osm_highway_types()

Source code

Class OsmHighwaySettingsWrapper in converterwrappers.py

OsmHighwaySettings

Methods

Properties

Example 1

See also

Source code

.activate_all_osm_highway_types()

.activate_osm_highway_type(+)

.activate_osm_highway_types(+)

.activate_osm_road_mode(+)

.add_allowed_highway_modes(+)

.collect_allowed_osm_highway_modes(+)

.deactivate_all_osm_highway_types_except(+)

.deactivate_all_osm_road_modes_except(+)

.deactivate_osm_highway_type(+)

.deactivate_osm_road_mode(+)

.deactivate_osm_road_modes(+)

.get_default_speed_limit_by_osm_highway_type(+)

.get_mapped_osm_road_modes(+)

.get_mapped_planit_road_mode(+)

.is_osm_highway_type_activated(+)

.is_osm_highway_type_deactivated(+)

.is_speed_limit_defaults_based_on_urban_area()

.overwrite_capacity_max_density_defaults(+)

.set_default_when_osm_highway_type_unsupported(+)

.set_speed_limit_defaults_based_on_urban_area(+)