PlanitIntermodalWriter

The PlanitIntermodalWriter class instance can be created via the IntermodalConverter. It provides the functionality to persist an (intermodal) network with zoning support (od and transfer zones, connectoids) in the native PLANit XML format.

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

Defaults in PLANit Intermodal Writer

The PLANit intermodal reader defaults are based on the settings of its underlying readers (network, zoning, (service network, and routed services)). The user can change these defaults if they deem this necessary via their respective settings. these settings are exposed via the intermodal writer 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 writing.

Minimum configuration requirements

The user is required to explicitly configure at least the following settings on a PlanitmIntermodalWriter:

• set an output directory via .settings.set_output_directory(+)

Methods

N/A

Properties

This class exposes the following properties:

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

PlanitIntermodalWriterSettings for configuration of the Planit (intermodal) network and zoning writer
ConverterFactory for the converter factory to create other types of converters
IntermodalReaderType for the supported intermodal reader types
IntermodalWriterType for the supported intermodal writer types

Source code

Class PlanitIntermodalWriterWrapper in converterwrappers.py