AppInterface.set_scen_attach_desc
AppInterface.set_scen_attach_desc |
Purpose
Update the description of an existing scenario attachment.
Synopsis
set_scen_attach_desc(self, filename: str, description: str) -> None
Arguments
|
filename
|
The filename of the scenario attachment to update
|
|
description
|
The new description of the attachment
|
Example
Example of setting the description of a scenario attachment
my_attach.dat to be "
This is my first attachment"
>>> insight.set_scen_attach_desc('my_attach.dat',
... 'This is my attachment')
... if insight.attach_status == AttachStatus.OK:
... print("Attachment description updated ok")
... else:
... print("Error updating attachment")
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the new attachment description was accepted.
2. The attachment will not be updated 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