.remove(+)
OD output configuration method
Description
The .remove(+) method, allows you to remove output properties from the ORigin-Destination (OD) based results, i.e., removing an existing column from each OD result row based on the provided output property.
If you decide to add and remove output properties, ensure that at least one method of unique identification for the OD remains in place. If not the assignment will fail.
Not all output properties are available in combination with OD results. For a list of compatible output properties see the OutputProperty.<enum> documentation
Signature
.remove(output_property)
with
| Parameter | Type | Unit | Compulsory | Description |
|---|---|---|---|---|
| output_property | OutputProperty.<enum> | - | YES | Choice of output property to remove |
Return type
None
Example 1
from planit import *
# prep
planit_instance = PLANit()
planit_instance.set(TrafficAssignment.TRADITIONAL_STATIC )
planit_instance.assignment.activate_output(OutputType.OD)
# remove the simulation run id from the OD results
planit_instance.assignment.od_configuration.remove(OutputProperty.RUN_ID)
See also
OutputProperty.<enum> for the available output property enums and their compatibility
Source code
Class ODOutputTypeConfigurationWrapper in wrappers.py