.add(+)
OD output configuration method
Description
The .add(+) method, allows you to add output properties to the Origin-Destination (OD) based results, i.e., adding a new column to each OD result row with the indicated result type outlined by the output property.
Not all output properties are available in combination with OD results. For a list of compatible output properties see the OutputProperty.<enum> documentation
Signature
.add(output_property)
with
| Parameter | Type | Unit | Compulsory | Description |
|---|---|---|---|---|
| output_property | OutputProperty.<enum> | - | YES | Choice of output property to add |
Return type
None
Example 1
from planit import *
# prep
planit_instance = Planit()
planit_instance.project.set(TrafficAssignment.TRADITIONAL_STATIC )
planit_instance.project.assignment.activate_output(OutputType.OD)
# complement the XML ids (of the input) of zones with the internal ids in PLANit in the OD results
planit_instance.project.assignment.od_configuration.add(OutputProperty.ORIGIN_ZONE_ID)
planit_instance.project.assignment.od_configuration.add(OutputProperty.DESTINATION_ZONE_ID)
See also
OutputProperty.<enum> for the available output property enums and their compatibility
Source code
Class ODOutputTypeConfigurationWrapper in projectwrappers.py