PlanitIntermodalReaderSettings

PlanitIntermodalReaderSettings instance

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

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

The zoning settings are additional settings for the physical infrastructure directly related to the zoning aspects, including the intermodal zoning component, of the reader, i.e., the parsing of (transfer) zones, such as od zones, but equally important and more important for the intermodal aspect of the reader; transfer zones such as bus stops, train stations, platforms, etc. 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 PlanitIntermodalReaderSettings instance exposes the following methods. The Compulsory column indicates it the user is expected to configure this setting explicitly or not.

Name Compulsory Default Description
.set_input_directory(+) YES N/A Set the input directory to obtain the input files from

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 zoning (OD and transfer) infrastructure

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)

See also

PlanitIntermodalReader intermodal reader class these settings reside on

Source code

Class PlanitIntermodalReaderSettingsWrapper in converterwrappers.py

.network_settings

PlanitIntermodalReaderSettings property

.set_input_directory(+)

PlanitNetworkReaderSettings method

.zoning_settings

PlanitIntermodalReaderSettings property

PlanitZoningReaderSettings

PlanitZoningReaderSettings instance

Last modified January 1, 0001