MantidQt::MantidWidgets::ProjectSaveModel Class Reference

#include <ProjectSaveModel.h>

Public Member Functions
std::vector< std::string >	getAllPythonInterfaces () const
	Return the list of python interfaces that can be saved.
virtual size_t	getProjectSize (const std::vector< std::string > &wsNames)
	Find the size of a project from a list of workspace names.
std::vector< MantidQt::API::IProjectSerialisable * >	getUniqueWindows (const std::vector< std::string > &wsNames) const
	Get all window handles for a collection of workspace names.
std::vector< WindowInfo >	getWindowInformation (const std::vector< std::string > &wsNames, bool includeUnattached=false) const
	Get all window information for a collection of workspaces.
std::vector< std::string >	getWindowNames (const std::vector< std::string > &wsNames) const
	Get all window names for a collection of workspace names.
std::vector< MantidQt::API::IProjectSerialisable * >	getWindows (const std::string &wsName) const
	Get all window handles for this workspace.
std::vector< WorkspaceInfo >	getWorkspaceInformation () const
	Get all workspace information.
std::vector< std::string >	getWorkspaceNames () const
	Get all workspace names.
std::vector< Mantid::API::Workspace_sptr >	getWorkspaces () const
	Get all workspaces from the ADS.
bool	hasWindows (const std::string &ws) const
	Check if a workspace has any windows attached to it.
bool	needsSizeWarning (const std::vector< std::string > &wsNames)
	Check if the size of the project is > than the warning size.
	ProjectSaveModel (const std::vector< MantidQt::API::IProjectSerialisable * > &windows, std::vector< std::string > activePythonInterfaces=std::vector< std::string >())
	Construct a new model instance with vector of window handles.

Private Member Functions
WindowInfo	makeWindowInfoObject (MantidQt::API::IProjectSerialisable *window) const
WorkspaceInfo	makeWorkspaceInfoObject (const Mantid::API::Workspace_const_sptr &ws) const
	Create a workspace info object for this workspace.

Private Attributes
std::vector< std::string >	m_activePythonInterfaces
std::vector< MantidQt::API::IProjectSerialisable * >	m_unattachedWindows
std::unordered_map< std::string, std::vector< MantidQt::API::IProjectSerialisable * > >	m_workspaceWindows
	Map to hold which windows are associated with a workspace.

Detailed Description

Definition at line 45 of file ProjectSaveModel.h.

Constructor & Destructor Documentation

ProjectSaveModel()

MantidQt::MantidWidgets::ProjectSaveModel::ProjectSaveModel	(	const std::vector< MantidQt::API::IProjectSerialisable * > &	windows,
		std::vector< std::string >	activePythonInterfaces = std::vector< std::string >()
	)

Construct a new model instance with vector of window handles.

Member Function Documentation

getAllPythonInterfaces()

std::vector< std::string > MantidQt::MantidWidgets::ProjectSaveModel::getAllPythonInterfaces

(

)

const

Return the list of python interfaces that can be saved.

getProjectSize()

virtual size_t MantidQt::MantidWidgets::ProjectSaveModel::getProjectSize ( const std::vector< std::string > &  wsNames )

virtual

Find the size of a project from a list of workspace names.

getUniqueWindows()

std::vector< MantidQt::API::IProjectSerialisable * > MantidQt::MantidWidgets::ProjectSaveModel::getUniqueWindows

(

const std::vector< std::string > &

wsNames

)

const

Get all window handles for a collection of workspace names.

getWindowInformation()

std::vector< WindowInfo > MantidQt::MantidWidgets::ProjectSaveModel::getWindowInformation	(	const std::vector< std::string > &	wsNames,
		bool	includeUnattached = false
	)		const

Get all window information for a collection of workspaces.

getWindowNames()

std::vector< std::string > MantidQt::MantidWidgets::ProjectSaveModel::getWindowNames

(

const std::vector< std::string > &

wsNames

)

const

Get all window names for a collection of workspace names.

getWindows()

std::vector< MantidQt::API::IProjectSerialisable * > MantidQt::MantidWidgets::ProjectSaveModel::getWindows

(

const std::string &

wsName

)

const

Get all window handles for this workspace.

getWorkspaceInformation()

std::vector< WorkspaceInfo > MantidQt::MantidWidgets::ProjectSaveModel::getWorkspaceInformation

(

)

const

Get all workspace information.

getWorkspaceNames()

std::vector< std::string > MantidQt::MantidWidgets::ProjectSaveModel::getWorkspaceNames

(

)

const

Get all workspace names.

getWorkspaces()

std::vector< Mantid::API::Workspace_sptr > MantidQt::MantidWidgets::ProjectSaveModel::getWorkspaces

(

)

const

Get all workspaces from the ADS.

hasWindows()

bool MantidQt::MantidWidgets::ProjectSaveModel::hasWindows

(

const std::string &

ws

)

const

Check if a workspace has any windows attached to it.

makeWindowInfoObject()

WindowInfo MantidQt::MantidWidgets::ProjectSaveModel::makeWindowInfoObject ( MantidQt::API::IProjectSerialisable *  window ) const

private

makeWorkspaceInfoObject()

WorkspaceInfo MantidQt::MantidWidgets::ProjectSaveModel::makeWorkspaceInfoObject ( const Mantid::API::Workspace_const_sptr &  ws ) const

private

Create a workspace info object for this workspace.

needsSizeWarning()

bool MantidQt::MantidWidgets::ProjectSaveModel::needsSizeWarning

(

const std::vector< std::string > &

wsNames

)

Check if the size of the project is > than the warning size.

Member Data Documentation

m_activePythonInterfaces

std::vector<std::string> MantidQt::MantidWidgets::ProjectSaveModel::m_activePythonInterfaces

private

Definition at line 87 of file ProjectSaveModel.h.

m_unattachedWindows

std::vector<MantidQt::API::IProjectSerialisable *> MantidQt::MantidWidgets::ProjectSaveModel::m_unattachedWindows

private

Definition at line 86 of file ProjectSaveModel.h.

m_workspaceWindows

std::unordered_map<std::string, std::vector<MantidQt::API::IProjectSerialisable *> > MantidQt::MantidWidgets::ProjectSaveModel::m_workspaceWindows

private

Map to hold which windows are associated with a workspace.

Definition at line 84 of file ProjectSaveModel.h.

---

The documentation for this class was generated from the following file:

• qt/widgets/common/inc/MantidQtWidgets/Common/ProjectSaveModel.h