.get_time_period_filters()

GtfsServicesReaderSettings method

Description

Use this method to retrieve the currently set time period filters (if any).

Since it is possible to set multiple time filters, the return type of this method is a list of 2-tuples. where each entry provides a single filter comprising the start and end time of the period, respectively.

Signature

.get_time_period_filters() -> Set[Tuple[datetime.time, datetime.time]]

Return type

Set[Tuple[datetime.time, datetime.time]]

Example 1

from planit import *

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

from planit import *

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

# <some_intermodal_reader> = construct OSM or PLANit intermodal reader for example 

# GTFS reader
gtfs_reader: GtfsIntermodalReaderWrapper = \
    intermodal_converter.create_reader(IntermodalReaderType.GTFS, "Australia", <some_intermodal_reader>)

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)

## Get time period filters we just set ##            
time_period_filters = gtfs_reader.settings.services_settings.get_time_period_filters()
assert len(time_period_filters) == 1
time_period_filter = time_period_filters.pop()
assert time_period_filter[0].hour == 6
assert time_period_filter[0].minute == 0
assert time_period_filter[0].second == 0
assert time_period_filter[1].hour == 9
assert time_period_filter[1].minute == 59
assert time_period_filter[1].second == 59

Source code

Class GtfsServicesReaderSettingsWrapper in converterwrappers.py