PlanitZoningReader

The PlanitZoningReader class instance can be created via the ZoningConverter. It provides the functionality to parse zoning systems in the native PLANit format, and possibly persist it in the same or another format using a ZoningWriter. Once created the user can configure its settings.

For information on the Planit XML format, please consult the Data formats/Input/Default section

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

As some zoning information is derived from underlying network, it is expected a network is available. this is indirectly provided via a network reader.

Minimum configuration requirements

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

• set an input directory via .settings.set_inputdirectory(+)

Methods

N/A

Properties

This class exposes the following properties:

Example 1

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)

# TNTP writer
tntp_writer = converter.create_writer(ZoningReaderType.TNTP)
tntp_writer.settings.<some_method>>

# perform conversion
converter.convert(planit_reader, tntp_writer)

See also

PlanitZoningReaderSettings for configuration of the PLANit zoning reader
ConverterFactory for the converter factory to create other types of converters
ZoningReaderType for the supported zoning reader types
ZoningWriterType for the supported zoning writer types

Source code

Class PlanitZoningReaderWrapper in converterwrappers.py