TMtxProgressDialog Class

Manages and provides progress indicators of multi-threaded algorithms.

The TMtxProgressDialog component greatly simplifies the display of progress indicators and offers built-in support to cancel the execution of algorithms running in it's background thread. The progress can be indicated with events or by displaying its improvised progress dialog.

The design does not use the Synchronize procedure to update progress indicators and makes the most out of the available CPU power.

Usage example:

myProgress.DefineLoop(0, 1000-1); //how many times OnCompute should be called myProgress.OnCompute := MyCompute; //Mycompute will be called from a single background thread myProgress.OnProgressUpdate := MyProgressUpdate; //for progress indicators. Runs in main apps thread myProgress.Start;

When the processing finishes, the OnProgressUpdate will be called with TMtxProgressEvent.peCleanUp param from the main UI thread. The computation can be cancelled, by setting

myProgress.Cancel := True;

If the desire is to cancel and to block execution until all the processing has stopped call:

myProgress.Stop;

If the desire is to block execution and wait until all the processing has stopped call:

myProgress.WaitToFinish; // prefer OnProgressUpdate to detect the end (!)

The blocking calls however defeat the primary purpose of this component, which is to provide non-blocking interface to launch, track and detect the end of processing.

The component is targeted at user interaction with the UI and its one internal thread should not be used for massivally parallel computations. Use MtxVec.DoForLoop for such tasks. DoForLoop could/should/can be placed inside of MyCompute to do the actual mult-threaded computation.