GeometryZoningWriterSettings

GeometryZoningWriterSettings instance

The GeometryZoningWriterSettings instance is accessible via the GeometryZoningWriter its .settings property. It allows the user to configure the GeometryZoningWriter output.

Minimum configuration requirements

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

Methods

A GeometryZoningWriterSettings instance exposes the following methods.

Name	Compulsory	Default	Description
`.set_output_directory(+)`	YES	N/A	Set the output directory to persist the output files to
`.set_country(+)`	NO	Context dependent	Set the country the zoning resides in, used to determine the coordinate reference system to apply
`.set_od_zones_file_name(+)`	NO	`planit_zones_od`	Set the origin-destination zones file name
`.set_persist_od_zones(+)`	NO	`True`	Set flag indicating whether to persist the origin-destination zones (or not)
`.set_transfer_zones_file_name(+)`	NO	`planit_zones_transfer`	Set the transfer zones file name (poles, platforms)
`.set_persist_transfer_zones(+)`	NO	`True`	Set flag indicating whether to persist the transfer zones (or not)
`.set_persist_virtual_network(+)`	NO	`True`	Set flag indicating whether to persist the virtual network (connectois to physical network) (or not)
`.set_transfer_connectoids_file_name(+)`	NO	`planit_connectoids_transfer`	Set the transfer connectoid vertices file name
`.set_persist_transfer_connectoids(+)`	NO	`True`	Set flag indicating whether to persist the transfer zone connectoid vertices (or not)
`.set_od_connectoids_file_name(+)`	NO	`planit_connectoids_od`	Set the origin-destination connectoid vertices file name
`.set_persist_od_connectoids(+)`	NO	`True`	Set flag indicating whether to persist the origin-destination zone connectoid vertices (or not)
`.set_connectoid_edges_file_name(+)`	NO	`planit_connectoid_edges`	Set the connectoid edges file name
`.set_connectoid_segments_file_name(+)`	NO	`planit_connectoid_edges`	Set the connectoid edge segments file name

Getters exist for most basic setters as well, e.g., .is_persist_od_zones(), however these are not yet documented explicitly.

Example

from planit import *

planit = Planit()

# zoning converter
zoning_converter = planit.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 = zoning_converter.create_reader(ZoningReaderType.PLANIT, planit_net_reader)
planit_reader.settings.set_inputdirectory(PLANIT_INPUT_PATH)

# GeoIo (GIS geometry shape) writer
geo_writer = zoning_converter.create_writer(ZoningWriterType.SHAPE)
geo_writer.settings.set_output_directory(OUTPUT_PATH)
geo_writer.settings.set_country("Australia")

# perform conversion
zoning_converter.convert(planit_reader, geo_writer)