.set_od_zones_file_name(+)

GeometryZoningWriterSettings method

Description

Set the file name to use for the GIS zoning origin-destination zones output (one per layer). The structure of each file name is set up as follows:

<user_defined_file_name>_<type)of_geometry>.shp,

We postfix by the geometry type so we can support different geometries for zones (points, linestrings etc.).

Signature

.set_od_zones_file_name(file_name: str)

with

Parameter Type Unit Default Description
file_name str None planit_zones_od The file name to use

Return type

N/A

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")

#Change file name
geo_writer.settings.set_od_zones_file_name(`my_name`)

# perform conversion
zoning_converter.convert(planit_reader, geo_writer)

See also

N/A

Source code

Class GeometryZoningWriterSettingsWrapper in converterwrappers.py