.convert(+)
DemandsConverter method
Description
The method that is to be called to perform the conversion from reader to writer.
Signature
.convert(reader, writer)
with
| Parameter | Type | Unit | Compulsory | Description |
|---|---|---|---|---|
reader |
DemandsReader |
None |
YES | The demands reader used to parse from |
writer |
DemandsWriter |
None |
YES | The demands writer used to persist to |
Return type
N/A
Example 1
from planit import *
# create a demands converter
planit_instance = Planit()
demands_converter = planit_instance.converter_factory.create(ConverterType.DEMANDS)
# TNTP demands reader requires compatible zones. These can be configured via a TNTP zoning reader
# For this example, it is assumed this has been configured already (see ZoningConverter to see how to do this)
tntp_zoning_reader # a presumed configured TNTP zoning reader
# example TNTP demands reader
tntp_dem_reader = demands_converter.create_reader(DemandsReaderType.TNTP, tntp_zoning_reader)
tntp_dem_settings = tntp_dem_reader.settings
tntp_dem_settings.set_demand_file_location(DEMAND_FILE_PATH)
tntp_dem_settings.set_start_time_since_midnight(8.0, TimeUnits.HOURS)
tntp_dem_settings.set_time_period_duration(1.0, TimeUnits.HOURS)
# example PLANit demands writer
planit_writer = demand_converter.create_writer(DemandsWriterType.PLANIT)
planit_writer.settings.set_output_directory("<path_to_output_dir>")
planit_writer.settings.set_country("<country_name>")
# perform conversion
demands_converter.convert(tntp_dem_reader, planit_writer)
See also
N/A
Source code
Class DemandsConverter in converter.py