Document future object interface

[rploconnor]

When I execute the following:
session.tui.solver.solve.report_plots.list()
It outputs the report plots to TUI but it appear to return the following:
<Future at 0x2175eea8808 state=running>

I would like it to return a list. Since I don't think there is any way to do it with the settings API, I am stuck using the following to generate the desired list:

reportdefs_string = session.scheme_eval.exec(('(ti-menu-load-string "solve/report-plots/list ")',))
reportdefs = reportdefs_string.split()
reportdefs.pop(0)

Is it possible to currently get the list in a cleaner way, or is this an enhancement request?

[dnwillia-work]

Yeah, I think you can call the future object maybe. At the very least we need to document what you can do with these returned objects.

[mkundu1]

To retrieve any structured data, settings API should be used. The TUI API executes TUI commands in Fluent, it doesn't return any value from Fluent. The issue related to listing of report-definitions via settings API is tracked under #185.

[dnwillia-work]

@mkundu1 If I write

ret = session.tui.solver.solve.report_plots.list()

What is the ret object and is it documented anywhere yet?

[mkundu1]

@dnwillia-work ret is an instance of Future type. I'll add documentation for it.

[dnwillia-work]

@mkundu1 OK, I see it's just generic Python object. I guess maybe the main thing to document somewhere is that commands may return this type and what the result() means for commands that return it.