Mantid
Loading...
Searching...
No Matches
Namespaces | Enumerations
MantidQt Namespace Reference

The AlgorithmProgressDialogPresenter keeps track of the running algorithms and displays a progress bar for them, and a property list. More...

Namespaces

namespace  API
 
namespace  CustomDialogs
 
namespace  CustomInterfaces
 
namespace  MantidWidgets
 
namespace  Widgets
 

Enumerations

enum  DistributionFlag { DistributionDefault = 0 , DistributionTrue , DistributionFalse }
 

Detailed Description

The AlgorithmProgressDialogPresenter keeps track of the running algorithms and displays a progress bar for them, and a property list.

The classes defined here encapuslate the layout and parameters of the individual shapes within Mantid.

Parses the formatting used in MantidPlot project files.

The ase class from which mantid custom widgets are derived it contains some useful functions.

The intetion of this module is to centralize the access to boost::python so that it is not scattered throughout this library.

This file defines functions for parsing numbers from QStrings.

parseKeyValueString

The base class from which mantid custom widgets are derived contains some useful functions.

This file contains declarations of options which control normalization of mantid curves.

See the developer documentation for Batch Widget at developer.mantidproject.org/BatchWidget/index.html.

The AlgorithmProgressWidget shows the main progress bar always visible on the Workbench.

The AlgorithmProgressPresenterBase is the base class that presenters showing progress bars use.

The AlgorithmProgressPresenter is the presenter for the progress bar always visible on the Workbench.

The AlgorithmProgressModel keeps track of all active presenters that are managing views with progress bars, and notifies them whenever they need to update due to an algorithm's event.

The AlgorithmProgressDialogWidget displays multiple progress bars for algorithms running simultaneously.

This widget shares uses the model from the main Workbench progress bar (AlgorithmProgressWidget).

It tracks the starting of all algorithms, and will set itself as observer on every started algorithm, tracking their start, update, finish and error events.

When an algorithm event fires it is on a separate thread from the views. An action in the presenter is triggered, which then emits a signal, bringing back the processing into the GUI thread, to do actual changes to GUI elements.

Note: this observer does NOT WAIT for the GUI event to finish. It triggers the event, which is then queued in the Qt event loop. If the algorithm must be used in the event, then the AlgorithmID can be used to retrieve a shared pointer to it, which keeps the algorithm alive for the duration.

It will update the progress bar with the first algorithm that has been run. If there are two or more running simultaneously, only the first one's progress will be displayed.

When the algorithm finishes, the ID is cleared, and the next algorithm that starts will be tracked.

Tracking only 1 algorithm at a time was done to allow the progress bar to completely fill up, rather than be constantly reset by newly started algorithms.

More than one progress bar is handled by the AlgorithmProgressDialogWidget.

It sets up the common connections for events from the model, e.g. when an algorithm has progressed and the progress bar value needs to be updated.

This class is also the creator/owner of the Details window, which can show multiple progress bars for algorithms running simultaneously (e.g. from 2 code editors).

Parses a string in the format ‘a = 1,b=2, c = "1,2,3,4", d = 5.0, e='a,b,c’` into a map of key/value pairs.

In theory updating to a different wrapper library would just require altering this file.

Author
Harry Jeffery, ISIS, RAL
Date
23/07/2014

Each is a widget that is to be displayed within the CreateSampleShapeDialog. The base class exists so that they can be stored in a container.

Enumeration Type Documentation

◆ DistributionFlag

Enumerator
DistributionDefault 
DistributionTrue 
DistributionFalse 

Definition at line 16 of file DistributionOptions.h.