Application Interface

>>> my_attachment = insight.app_attach_info('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment description: ", my_attachment.description)
... else:
...     print("Error querying attachment")		

>>> insight.app_id = 'xyzzy'		

>>> print('app id = ', insight.app_id)
app id = xyzzy		

>>> insight.app_name = 'My App'		

>>> print('app name = ', insight.app_name)
app name = My App		

>>> insight.delete_scen_attach('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment deleted")
... else:
...     print("Error deleting attachment")		

>>> insight.exec_mode = 'CALCULATE_STATS'		

>>> print('execution mode = ', insight.exec_mode)
execution mode = CALCULATE_STATS		

>>> insight.get_app_attach('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
...     with open('my_attach.dat') as f:
...         pass  # process the file
... else:
...     print("Error retrieving attachment")		

>>> attachment = insight.get_attach_by_tag('mytag1')
... if insight.attach_status != AttachStatus.OK:
...     print("Error searching for attachments")
... else:
...     with open(attachment.filename) as f:
...         pass  # process the file		

>>> filenames = insight.get_attach_by_tag('mytag1')
... if insight.attach_status != AttachStatus.OK:
...     print("Error searching for attachments")
... else:
...     for f in filenames:
...         print(f)		

>>> rules = insight.get_attach_rules()		

>>> attachments = insight.get_attachs_by_tag('mytag1')
... if insight.attach_status != AttachStatus.OK:
...     print("Error searching for attachments")
... else:
...     for a in attachments:
...         print(a.filename)		

>>> info = insight.get_item_info('/my_app/my_scenario')		

>>> @xi.ExecModeLoad()
>>> def load(self):
>>>     try:
>>>         info = self.insight.get_item_info(".")
>>>         print(info)
>>>     except xi.InterfaceError as ex:
>>>         print(ex)		

>>> info = insight.get_item_infos('/my_app/my_folder')		

>>> @xi.ExecModeLoad()
>>> def load(self):
>>>     try:
>>>         infos = self.insight.get_item_infos(".")
>>>         print(infos)
>>>     except xi.InterfaceError as ex:
>>>         print(ex)		

>>> insight.get_scen_attach('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
...     with open('my_attach.dat') as f:
...         pass  # process the file
... else:
...     print("Error retrieving attachment")		

>>> insight.get_scen_attach('my_attach.dat', '/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
...     with open('my_attach.dat') as f:
...         pass  # process the file
... else:
...     print("Error retrieving attachment")		

>>> atts = insight.list_app_attach()
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> atts = insight_list_app_attach_by_tag('mytag1')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> tags = insight.list_attach_tags()
... if insight.attach_status == AttachStatus.OK:
...     print("Defined tags: ", tagslist)
... else:
...     print("Error retrieving tags list")		

>>> atts = insight.list_scen_attach()
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> atts = insight.list_scen_attach('/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> atts = insight.list_scen_attach_by_tag('mytag1')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> atts = insight.list_scen_attach_by_tag('mytag1',
...                                        '/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachments: ", atts)
... else:
...     print("Error listing attachments")		

>>> insight.put_scen_attach('my_attach.dat', False)
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment added ok")
... elif insight.attach_status == AttachStatus.ALREADY_EXISTS:
...     print("Attachment already exists")
... else:
...     print("Error adding attachment:", insight.attach_status)		

>>> 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")		

>>> insight.reset_progress()		

>>> my_attachment = insight.scen_attach_info('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment description: ", my_attachment.description)
... else:
...     print("Error querying attachment")		

>>> insight.scenario_id = 'xyzzy'		

>>> print('scenario id = ', insight.scenario_id)
scenario id = xyzzy		

>>> insight.scenario_name = 'Scenario B'		

>>> print('scenario name = ', insight.scenario_name)
scenario name = Scenario B		

>>> insight.scenario_path = '/myapp/DirA/myscenario'		

>>> print('scenario path = ', insight.scenario_path)
scenario path = /myapp/DirA/myscenario		

>>> insight.set_attach_rules(AttachmentRules(
...     max_size=1*1024*1024,
...     max_attach_count=25,
...     max_filename_len=32,
...     invalid_filename_chars=['/', r'', ' '],
...     max_description_len=128,
... ))		

>>> insight.set_attach_tags([
...     AttachTag(name='first', usage=AttachTagUsage.SINGLE_FILE),
...     AttachTag(name='test', usage=AttachTagUsage.MULTI_FILE),
... ])		

>>> 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")		

>>> insight.set_scen_attach_hidden('my_attach.dat', True)
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment hidden ok")
... else:
...     print("Error hiding attachment")		

>>> insight.set_scen_attach_tags('my_attach.dat',
...                              ['mytag1', 'mytag2'])
... if insight.attach_status == AttachStatus.OK:
...     print("Attachment tags updated ok")
... else:
...     print("Error updating attachment")		

>>> print(insight.test_app_attach_dir)		

>>> insight.test_app_attach_dir = 'C:/dev/appattachments'		

>>> insight.test_attach_dir = 'C:/dev/appattachments'		

>>> print(insight.test_attach_dir)		

>>> insight.test_cfile_path = 'C:/dev/app/application.xml'		

>>> print(insight.test_cfile_path)		

>>> insight.test_scen_attach_dir = 'C:/dev/scenattachments'		

>>> print(insight.test_scen_attach_dir)		

>>> insight.update(Metric.OBJVAL, 51.9)		

>>> def on_gap_notify(prob, app):
...
...     num_sol = prob.attributes.mipsols
...     app.insight.update(xi.Metric.NUMSOLS, num_sol)
...
...     if num_sol == 0:
...         # Can only occur when mipabsgapnotifybound is used.
...         # Don't call gapnotify again.
...         return None, None, None, None
...
...     objective = prob.attributes.mipobjval
...     best_bound = prob.attributes.bestbound
...
...     if best_bound != 0 or objective != 0:
...         gap = abs(objective - best_bound) / \
...               max(abs(best_bound), abs(objective))
...     else:
...         gap = 0
...
...     app.insight.update(xi.Metric.OBJVAL, objective)
...     app.insight.update(xi.Metric.GAP, gap)
...
...     if gap > 1e-6:
...         new_rel_gap_notify_target = gap - 1e-6
...     else:
...         # Don't call gapnotify again.
...         new_rel_gap_notify_target = -1
...
...     return new_rel_gap_notify_target, None, None, None		

>>> prob = xp.problem()
...
... # TODO: Define the optimization problem
...
... # Optionally reset progress and set the objective sense
... self.insight.reset_progress()
... self.insight.update(xi.Metric.OBJSENSE, prob.attributes.objsense)
...
... prob.controls.miprelgapnotify = 1e20
... prob.addcbgapnotify(on_gap_notify, self, 0)
...
... prob.solve()		

>>> insight.username = 'LouisXIV'		

>>> print('user name = ', insight.username)
user name = LouisXIV		

>>> @xi.ExecModeLoad()
>>> def load(self):
>>>     try:
>>>         info = self.insight.get_item_info(".")
>>>         print(info)
>>>     except xi.InterfaceError as ex:
>>>         print(ex)  # Print error type and message.
>>>         # print("ERROR:", ex.message)  # Print error message.