PlanitZoningReaderSettings

PlanitZoningReaderSettings instance

The PlanitZoningReaderSettings instance is accessible via the PlanitIntermodalReaderSettings its .zoning_settings property. It allows the user to configure the zoning aspects of the PlanitIntermodalReader.

Minimum configuration requirements

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

Methods

A PlanitZoningReaderSettings 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(+)`	NO	N/A	Set the input directory to search for zoning XML file (only when the input directory is not set/differs from the intermodal reader settings, it should be set)
`.set_xml_file_extension(+)`	NO	`xml`	Change the file extension to look consider in case the xml file does not use the regular `.xml` extension

Properties

N/A

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>")
planit_reader.settings.zoning_settings.<some_method>

Source code

Class ReaderSettingsWrapper in converterwrappers.py

.set_input_directory(+)

PlanitZoningReaderSettings method

.set_xml_file_extension(+)