.set_input_directory(+)
PlanitZoningReaderSettings method
The PlanitZoningReaderSettings
instance is accessible via the PlanitZoningReader
its .settings
property. It allows the user to configure the PlanitZoningReader.
Note: in the special case the zoning settings are accessed via an Intermodal reader settings instance, they can be retrieved via
intermodal_reader_instance.settings.zoning_settings
rather thanzoning_reader_instance.settings
All methods marked as Compulsory=YES
in the Methods section are expected to be configured by the user explicitly.
A PlanitZoningReaderSettings
instance exposes the following methods. The Compulsory column indicates it the user is
expected to configure this setting explicitly or not.
Nam | 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 |
N/A
from planit import *
# create a zoning converter
planit_instance = Planit()
converter = planit_instance.converter_factory.create(ConverterType.ZONING)
# prerequisite network reader
# PLANIT_INPUT_PATH = ...
planit_net_reader = planit_instance.converter_factory.create(ConverterType.NETWORK).create_reader(NetworkReaderType.PLANIT)
planit_net_reader.settings.set_input_directory(PLANIT_INPUT_PATH)
# PLANit zoning reader
planit_reader = converter.create_reader(ZoningReaderType.PLANIT, planit_net_reader)
planit_reader.settings.set_inputdirectory(PLANIT_INPUT_PATH)
PlanitIntermodalReaderSettings
Planit intermodal reader settings class these zoning settings reside on
Class ReaderSettingsWrapper
in converterwrappers.py
PlanitZoningReaderSettings method
PlanitZoningReaderSettings method