GtfsIntermodalReaderSettings

The GtfsIntermodalReaderSettings instance is accessible via the GtfsIntermodalReader its .settings property. It allows the user to configure the GtfsIntermodalReader. We differentiate between:

• General settings (this settings)
• Services related settings - public transport services configuration
• Zoning (poles/platforms) settings - public transport poles and platforms configuration

The general settings are described here, and reflect general settings across the various aspects of the intermodal reader.

The services settings pertain to public transport services configurations and filtering, whereas the zoning settings as they relate to transfer zones (poles/platforms).

The EXTENDED GTFS RouteTypes (modes) are supported as defined in the GTFS specification. There is a default mapping available to PLANit predefined mode types, which may be altered by the user if so desired via the services_Settings.

Minimum configuration requirements

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

Methods

A GtfsIntermodalReaderSettings instance exposes the following methods. The Compulsory column indicates it the user is expected to configure this setting explicitly or not.

Properties

This class exposes the following properties

Example

from planit import *

# create an intermodal converter
planit_instance = Planit()
intermodal_converter = planit_instance.converter_factory.create(ConverterType.INTERMODAL)

# Network reader to use to impose GTFS on:
#   Open Street Map (OSM) intermodal reader        
osm_reader = intermodal_converter.create_reader(IntermodalReaderType.OSM, "Australia")
osm_reader.settings.set_input_file(SYDNEY_OSM_PBF_FILE_PATH)

# GTFS reader
gtfs_reader: GtfsIntermodalReaderWrapper = \
    intermodal_converter.create_reader(IntermodalReaderType.GTFS, "Australia", osm_reader)
gtfs_reader.settings.set_input_file(SYDNEY_GTFS_FILE_PATH)

gtfs_reader.settings.services_settings.day_of_week = DayOfWeek.THURSDAY
gtfs_reader.settings.services_settings.add_time_period_filter(
    datetime.time(hour=6, minute=0, second=0),
    datetime.time(hour=9, minute=59, second=59)
)

# PLANit writer
planit_writer = intermodal_converter.create_writer(IntermodalWriterType.PLANIT)
planit_writer.settings.set_output_directory(OUTPUT_PATH)
planit_writer.settings.set_country("Australia")

# perform conversion (with services)
intermodal_converter.convert_with_services(gtfs_reader, planit_writer)

See also

GtfsIntermodalReader GTFS intermodal reader class these settings reside on

Source code

Class GtfsIntermodalReaderSettingsWrapper in converterwrappers.py