Using the progress monitor in long running scripts

Question

Most batch scripts are just running a few milli seconds or seconds, so no need to report any progress back to the user. However, especialyl (but not only) long running scripts should somehow feed back to the user how much progress they made and what they are currently doing.

For that purpose an instance of an IProgressMonitor named "progressMonitor" is passed to he script. It basicaly gives the script access to the monitor that is visualized in the modal dialog that is open while the script is running.

I just have posted a simple script here to illustrate the possibilities.

Happy Progress Reporting

Jan

medini_1024169437 · Answer

Marian, I investigated a bit and you are right, it is not (anymore) possible to start an indeterminate task.

I wrote "anymore" as I am half sure it worked. However, we have introduced a few changes over the last releases which make this more tricky, one is that each scripting operation is now a composite operation with potential sanity checks before and after. Composite operations already have their own way of dealing with the progres smonitoring, they basically split it amon the individual parts of the composite. That breaks any "indeterminate" state.

I have ano solution right now and I frankly dont really like the use of any root monitor but cant offer a better solutuon in short or even mid term.

Jan

medini_1024169437 · Answer

Interesting, while this is a great achievement and workaround, it somewhat "twists the meaning" of using the progress monitor to report progress in any non-ui thread without caring any UI.

Strange. My takeaway is your first statement, "will not propagate up to the one in the dialog" which I would treat as a defect. I'll start some investigation.

Happy progressing

Jan

medini_1063548292 · Answer

Hi Jan,
 I cracked the nut open!

7

so beginTask("Indeterminate task,-1") at sub monitors will not propagate up to the one in the dialog ..
 in other wrods i used  UI class

* get the root monitor ( should be the animating ) 
* use beginTask ("task knight rider",-1) , has to do it within UI.execute :)

so one need to have bind (experimental pragma) with UI class in it if a knight rider is required:)

//$EXPERIMENTAL$
load("~/.lib/ui.js") ;
var rootmon = progressMonitor;
while (rootmon != UI.getRootProgressMonitor(rootmon)){
 rootmon = UI.getRootProgressMonitor(rootmon)
} 
//configure it, need to be in UI thread 
UI.execute function( (m){
 rootmon.beginTask("Indeterminate task",-1);
});

Drawback is than once dome and want to switch over to predictable task one need to use  monitor actions in UI thread( same applicable for submonitor)

//gettin back to static one 
 UI.execute(function (m){rootmon.beginTask("Lame task",200);}...
//update tick
 UI.execute(function (m){rootmon.worked(x);})

//using submonitor 
 UI.execute(function (m){progressMonitor = progressMonitor.class.convert(rootmon,"Lame task ",200);}

//update tick 
 UI.execute(function (m){progressMonitor.worked(x);})

//wrapping function
function updateMonitor(funObj) {
 UI.execute(function upd(k) {
 funObj.call(null,progressMonitor);
 });
}
//update tick through wrapper
updateMonitor(a=>a.worked(10))

Marian