AppInterface.rename_scen_attach
AppInterface.rename_scen_attach |
Purpose
Renames an existing scenario attachment.
Synopsis
rename_scen_attach(self, old_name: str, new_name: str) -> None
Arguments
|
old_name
|
The existing filename of the attachment to be renamed
|
|
new_name
|
The new filename of the attachment. Must not already be used for a scenario attachment.
|
Example
Example of renaming an existing attachment of the current scenario from
my_attach.dat to
my_attach-2015.dat.
>>> insight.rename_scen_attach('my_attach.dat', 'my_attach-2015.dat')
... if insight.attach_status == AttachStatus.OK:
... print("Attachment renamed ok")
... else:
... print("Error renaming attachment")
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the new attachment name was accepted.
2. The attachment will not be renamed on the Insight server until the scenario completes.
3. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics