PlanitIntermodalWriterSettings

PlanitIntermodalWriterSettings instance

The PlanitIntermodalWriterSettings instance is accessible via the PlanitIntermodalWriter its .settings property. It allows the user to configure the PlanitIntermodalWriter. We differentiate between:

The network settings are identical to the settings exposed by the PlanitNetworkWriter and are described in detail under PlanitNetworkWriterSettings. These settings configure everything related to the physical road and/or rail network.

The zoning (public transport) settings are settings for travel zones (OD zones) and the physical infrastructure directly related to the intermodal aspect of the writer, i.e., the bus stops, train stations, platforms, etc. This information is extracted from PLANit’s intermodal zoning component, e.g., transfer zones, and connectoids (hence its categorisation under zones). They are described under Zoning Settings

Minimum configuration requirements

All methods marked as Compulsory=YES in the Methods section are expected to be configured by the user explicitly.

Methods

A PlanitIntermodalWriterSettings instance exposes the following methods.

Name Compulsory Default Description
.set_country(+) NO Context dependent Set the country the intermodal network resides in, used to determine the coordinate reference system to apply
.set_output_directory(+) YES N/A Set the output directory to persist the output files to

Properties

This class exposes the following properties

Property Availability Description
.network_settings Always Settings specific to physical road infrastructure
.zoning_settings Always Settings specific to intermodal public transport transfer (zones) infrastructure and travel zones

Example 1 - Minimum required settings

from planit import *

# create an intermodal converter
planit_instance = Planit()
intermodal_converter = planit_instance.converter_factory.create(ConverterType.INTERMODAL)

# Open Street Map (OSM) intermodal reader        
osm_reader = intermodal_converter.create_reader(IntermodalReaderType.OSM, "<country_name>")
osm_reader.settings.set_input_file("<path_to_input_file>")

# PLANit intermodal writer
planit_writer = intermodal_converter.create_writer(IntermodalWriterType.PLANIT)
planit_writer.settings.set_output_directory("<path_to_output_dir>")

# perform conversion
intermodal_converter.convert(osm_reader,planit_writer)

See also

PlanitIntermodalWriter Planit intermodal writer class these settings reside on

Source code

Class PlanitIntermodalWriterSettingsWrapper in converterwrappers.py

.network_settings

PlanitIntermodalWriterSettings property

.set_country(+)

PlanitIntermodalWriterSettings method

.set_output_directory(+)

PlanitNetworkWriterSettings method

.zoning_settings

PlanitIntermodalWriterSettings property

PlanitZoningWriterSettings

PlanitZoningWriterSettings instance

Last modified January 1, 0001