.remove_all_properties()

Description

The .remove_all_properties() method, will remove all currently registered output properties from the Origin-Destination (OD) based results configuration, including any properties that were initiated by default.

If you decide to remove output properties, ensure that at least one method of unique identification for the OD remains in place. If not the assignment will fail.

Signature

.remove_all_properties()

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 all output properties and then add only the OD ids and cost
planit_instance.assignment.path_configuration.remove_all_properties()
planit_instance.assignment.od_configuration.add(OutputProperty.ORIGIN_ZONE_XML_ID)
planit_instance.assignment.od_configuration.add(OutputProperty.DESTINATION_ZONE_XML_ID)
planit_instance.assignment.od_configuration.add(OutputProperty.OD_COST)

See also

OutputProperty.<enum> for the available output property enums

Source code

Class ODOutputConfigurationWrapper in wrappers.py