FrameworkManagerImpl

This is a Python binding to the C++ class Mantid::API::FrameworkManagerImpl.

What is it?

The framework manager is the main class through which user code will interact with the Mantid framework. It is the center piece of the application programming interface.

The main purpose of the frameworkManager is to simplfy the interaction with the various internal services of the Mantid framework. Of course this does not prevent you from accessing those services directly should you so wish.

What does it allow you to do?

The frameworkManager allows you to create and execute algorithms as well as retrieving workspaces, and deleting them if they are no longer required.

It is good practice to delete workspaces that are no longer required to free up the memory used.

For the most up to date listing of the methods that Framework Manager provides look at the Doxygen code documentation. Select the classes tab and look for FrameworkManagerImpl (Mantid::API).

Reference

class mantid.api.FrameworkManagerImpl

static Instance() → FrameworkManagerImpl :

Return a reference to the singleton instance

clear((FrameworkManagerImpl)self) → None :

Clear all memory held by Mantid

clearAlgorithms((FrameworkManagerImpl)self) → None :

Clear memory held by algorithms (does not include workspaces)

clearData((FrameworkManagerImpl)self) → None :

Clear memory held by the data service (essentially all workspaces, including hidden)

clearInstruments((FrameworkManagerImpl)self) → None :

Clear memory held by the cached instruments

clearPropertyManagers((FrameworkManagerImpl)self) → None :

Clear memory held by the PropertyManagerDataService

getNumOMPThreads((FrameworkManagerImpl)self) → int :

Returns the number of OpenMP threads that will be used.

static hasInstance() → bool :

Returns True if Instance has been called, false otherwise

setNumOMPThreads((FrameworkManagerImpl)self, (int)nthread) → None :

Set the number of OpenMP threads to the given value

setNumOMPThreadsToConfigValue((FrameworkManagerImpl)self) → None :

Sets the number of OpenMP threads to the value specified in the config file

shutdown((FrameworkManagerImpl)self) → None :

Effectively shutdown this service