PlanitIntermodalReader

PlanitIntermodalReader instance

The PlanitIntermodalReader class instance can be created via the IntermodalConverter. It provides the functionality to parse a Planit intermodal network and zoning (including transfer zones representing the intermodal component).

All configuration of this reader is performed via its .settings property, providing access to the PlanitIntermodalReaderSettings.

Defaults in Planit Intermodal Reader

The Planit intermodal reader defaults are bassed on the settings of the two underlying readers (network and zoning). The user can change these defaults if they deem this necessary via their respective settings that are in turn are made available via the intermodal reader settings property.

If, after reading the documentation, you are still unsure what defaults are adopted, have a look at the generated logs when using the reader. Planit will log the majority of the adopted defaults in its output when performing the OSM intermodal network reading.

Minimum configuration requirements

The user is required to explicitly configure at least the following settings on an PlanitIntermodalReader:

set an InputFile via .settings.set_input_directory(+)

Methods

N/A

Properties

This class exposes the following properties:

Property	Availability	Description
`.settings`	Always	Access to `PlanitIntermodalReaderSettings` to configure the reader

Example 1 - Minimum required settings

from planit import *

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

# PLANit intermodal reader        
planit_reader = intermodal_converter.create_reader(IntermodalReaderType.PLANIT)
planit_reader.settings.set_input_directory("<path_to_input_files>")

# Matsim intermodal writer
matsim_writer = intermodal_converter.create_writer(IntermodalReaderType.MATSIM)
matsim_writer.settings.set_output_directory("<path_to_output_dir>")

# perform conversion
intermodal_converter.convert(planit_reader,matsim_writer)

Source code

Class PlanitIntermodalReaderWrapper in converterwrappers.py

.settings

PlanitIntermodalReader property

Last modified January 1, 0001