.set_xml_name_root(+)
Default PLANit Output Formatter method
Description
The .set_xml_name_root(+) method provides you with the option to overwrite the default description, a.k.a. prefix, a.k.a. name root, part (DEFAULT_XML_NAME_PREFIX) for the XML output files of a PLANit traffic assignment run.
It is recommended to not include spaces in this description for readability reasons and to keep it as short as possible
Signature
.set_xml_name_root(run_description)
with
| Parameter | Type | Unit | Compulsory | Description |
|---|---|---|---|---|
run_description |
string |
None |
YES | Short description of run |
Return type
None
Example 1
from planit import *
#prep
plan_it = Planit()
# configure to persist output in same directory
plan_it.project.output.set_xml_name_root("test1")
#
# <more configuration>
#
plan_it.project.run()
See also
N/A
Source code
Class PlanItOutputFormatterWrapper in projectwrappers.py