GeometryNetworkWriterSettings

GeometryNetworkWriterSettings instance

The GeometryNetworkWriterSettings instance is accessible via the GeometryNetworkWriter its .settings property. It allows the user to configure the GeometryNetworkWriter 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 GeometryNetworkWriterSettings 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 network resides in, used to determine the coordinate reference system to apply
`.set_links_file_name(+)`	NO	`True`	Set the links file name
`.set_nodes_file_name(+)`	NO	`planit_links`	Set the nodes file name
`.set_persist_links(+)`	NO	`True`	Set flag indicating whether to persist the links (or not)
`.set_persist_nodes(+)`	NO	`planit_nodes`	Set flag indicating whether to persist the nodes (or not)

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

Example

from planit import *

planit = Planit()

# network converter
network_converter = planit.converter_factory.create(ConverterType.NETWORK)

# PLANit reader
planit_reader = network_converter.create_reader(NetworkReaderType.PLANIT, AUSTRALIA)
planit_reader.settings.set_input_directory(PLANIT_INPUT_PATH)

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

# perform conversion
network_converter.convert(planit_reader, geo_writer)