Add algorithms as methods on workspaces

[Martyn Gigg]

From design doc

Only algorithms specifically marked for addition to a particular DataObject will be added as methods. This will be controlled by two additional overridable methods on the base algorithm class:

• std::string methodName() – the name the method should be called when attached to a dataobject.

for example DeteleWorkspace it would be Delete. The default would be and empty string.

• std::string methodOn() – The class defining which DataObjects this would be a method on
• std::string methodInputProperty() – The class defining which DataObjects this would be a method on

[Nick Draper]

Moved to iteration 33 at iteration 32 code freeze

[Nick Draper]

Moved at end of release 2.1

[Nick Draper]

Moved at the end of release 2.2

[Nick Draper]

Moved to milestone 2.4

[Nick Draper]

Moved to r2.6 at the end of r2.5

[Martyn Gigg]

Batch move to 2.7

[Martyn Gigg]

Add structure to define runtime class methods on workspaces...

to algorithm base classes. Refs #4218

Changeset: 1a63ba3a96ef0852b34dee36387507f18e777244

[Martyn Gigg]

Export algorithm workspace methods descriptors to Python. Refs #4218

Changeset: b8c87c0b43a7329f4a0a48e61f3a74ccf7d03238

[Martyn Gigg]

Attach algorithm functions as methods when requested.

On startup, when the simple api is compiled the functions are attached to the appropriate workspace classes defined by the algorithm. Refs #4218

Changeset: 62ef5edfff4ae7396ca04d68d2ef1456d44fa040

[Martyn Gigg]

Documentation fixes for sphinx markdown.

Refs #4218

Changeset: 04b962535d8688ff2950f47c4a88a282d3cd57b6

[Martyn Gigg]

Generate the correct method signatures for algorithm the methods.

Refs #4218

Changeset: 16209c3cdd2684de4ddd5be2235e2e29e74b797e

[Martyn Gigg]

Fix attribute error in _workspaceops.

The api module is not quite imported yet so don't use the aliases Refs #4218

Changeset: 7d05f0ba2f23c3e73fa67aa3d8ef0f9d49b87cb8

[Martyn Gigg]

Expose Rebin as workspace method and use it in testing.

Refs #4218

Changeset: 775d7aa85794c6473643d8700778f770e7c30287

[Martyn Gigg]

Fix problem when using workspace methods with positional arguments.

Refs #4218

Changeset: 146f5faf384daad1e08ac1a06594da0fc8bbb14f

[Martyn Gigg]

Export other algorithms as methods on workspaces.

Refs #4218

Changeset: 32059522feee51d8ae14d5f6bfc12f7a86226382

[Martyn Gigg]

Improve error message when position args are used but not needed.

Refs #4218

Changeset: 9ac8d0b306115480724768991c3ea52d3cc9086b

[Martyn Gigg]

Export RenameWorkspace as .rename method.

Refs #4218

Changeset: 36d0e2f3ee6b2d5377bad4cb9174fe7832e82205

[Martyn Gigg]

Branch: feature/4218_algs_as_python_methods

Tester: This covers the implementation of algorithms as methods and the exporting of a few frequently used algorithms. Others can be considered in future tickets.

This work will allow things like:

w = Load('myfile')
w.delete() ...

The algorithms exposed as methods, with their corresponding method names, currently are:

• DeleteWorkspace --> delete
• RenameWorkspace --> rename
• CloneWorkspace --> clone
• ConvertUnits --> convertUnits
• Rebin --> rebin
• MaskDetectors --> maskDetectors

The workspace that calls the method should get set as the input workspace and then all other arguments passed as expected to the algorithm. Basically calling the free function and the method approach on the same workspace should produce identical results given the same parameters.

[Samuel Jackson]

Tested each of the algorithms and they appear to work fine. However, not all of the exposed algorithms appear to show up in the auto complete suggestion box when typing in the script window.

The following two did show up:

• Rebin
• Clone

But the others listed above did not auto complete.

[Martyn Gigg]

Please retest.

[Nick Draper]

good, but I think we may want to revisit rename and the intellisense help

[Nick Draper]

Merge remote-tracking branch 'origin/feature/4218_algs_as_python_methods'

Full changeset: ​4d4fa5f65ef2dc65d0cb572a7a836e973c996537

[Stuart Campbell]

This ticket has been transferred to github issue ​5065