MantidQt::MantidWidgets::CatalogHelper Class Reference

#include <CatalogHelper.h>

Public Member Functions
const std::vector< std::string >	downloadDataFiles (const std::vector< std::pair< int64_t, std::string > > &userSelectedFiles, const std::string &downloadPath, const std::string &sessionID)
	Download dataFile (via HTTP or copy if access to archive) and return the path to it.
void	executeGetDataFiles (const std::string &investigationId, const std::string &sessionID)
	Search for all related dataFiles for the specified investigation.
void	executeSearch (const std::map< std::string, std::string > &userInputs, const int &offset, const int &limit, const std::vector< std::string > &sessionIDs)
	Run the search algorithm with the given user input.
const std::vector< std::string >	getInstrumentList (const std::vector< std::string > &sessionIDs)
	Obtain the list of instruments that are available for the given session information.
const std::vector< std::string >	getInvestigationTypeList (const std::vector< std::string > &sessionIDs)
	Obtain the list of instruments that are available.
int64_t	getNumberOfSearchResults (const std::map< std::string, std::string > &userInputFields, const std::vector< std::string > &sessionIDs)
	Obtain the number of search results to be returned by the query of the user.
time_t	getTimevalue (const std::string &inputDate)
	Creates a time_t value from an input date ("23/06/2003") for comparison.
void	showLoginDialog ()
	Executes the catalog login algorithm dialog, returning immediately.
void	showPublishDialog ()
	Create a publishing dialog.
const std::map< std::string, std::string >	validateProperties (const std::map< std::string, std::string > &inputFields)
	Validate each input field against the related algorithm property.

Private Member Functions
Mantid::API::IAlgorithm_sptr	createCatalogAlgorithm (const std::string &algName)
	Creates an algorithm with the name provided.
void	executeAsynchronously (const Mantid::API::IAlgorithm_sptr &algorithm)
	Execute the given algorithm asynchronously.
const std::string	propertyDocumentation (const std::vector< Mantid::Kernel::Property * > &properties, const std::string &name)
	Obtain the documentation for a given name from the given algorithm properties.
void	setSearchProperties (const Mantid::API::IAlgorithm_sptr &catalogAlgorithm, const std::map< std::string, std::string > &userInputFields)
	Set the "search" properties to their related input fields.

Detailed Description

Definition at line 14 of file CatalogHelper.h.

Member Function Documentation

createCatalogAlgorithm()

Mantid::API::IAlgorithm_sptr MantidQt::MantidWidgets::CatalogHelper::createCatalogAlgorithm ( const std::string &  algName )

private

Creates an algorithm with the name provided.

downloadDataFiles()

const std::vector< std::string > MantidQt::MantidWidgets::CatalogHelper::downloadDataFiles	(	const std::vector< std::pair< int64_t, std::string > > &	userSelectedFiles,
		const std::string &	downloadPath,
		const std::string &	sessionID
	)

Download dataFile (via HTTP or copy if access to archive) and return the path to it.

executeAsynchronously()

void MantidQt::MantidWidgets::CatalogHelper::executeAsynchronously ( const Mantid::API::IAlgorithm_sptr &  algorithm )

private

Execute the given algorithm asynchronously.

executeGetDataFiles()

void MantidQt::MantidWidgets::CatalogHelper::executeGetDataFiles	(	const std::string &	investigationId,
		const std::string &	sessionID
	)

Search for all related dataFiles for the specified investigation.

executeSearch()

void MantidQt::MantidWidgets::CatalogHelper::executeSearch	(	const std::map< std::string, std::string > &	userInputs,
		const int &	offset,
		const int &	limit,
		const std::vector< std::string > &	sessionIDs
	)

Run the search algorithm with the given user input.

getInstrumentList()

const std::vector< std::string > MantidQt::MantidWidgets::CatalogHelper::getInstrumentList

(

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

sessionIDs

)

Obtain the list of instruments that are available for the given session information.

getInvestigationTypeList()

const std::vector< std::string > MantidQt::MantidWidgets::CatalogHelper::getInvestigationTypeList

(

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

sessionIDs

)

Obtain the list of instruments that are available.

getNumberOfSearchResults()

int64_t MantidQt::MantidWidgets::CatalogHelper::getNumberOfSearchResults	(	const std::map< std::string, std::string > &	userInputFields,
		const std::vector< std::string > &	sessionIDs
	)

Obtain the number of search results to be returned by the query of the user.

getTimevalue()

time_t MantidQt::MantidWidgets::CatalogHelper::getTimevalue

(

const std::string &

inputDate

)

Creates a time_t value from an input date ("23/06/2003") for comparison.

propertyDocumentation()

const std::string MantidQt::MantidWidgets::CatalogHelper::propertyDocumentation ( const std::vector< Mantid::Kernel::Property * > &  properties, const std::string &  name  )

private

Obtain the documentation for a given name from the given algorithm properties.

setSearchProperties()

void MantidQt::MantidWidgets::CatalogHelper::setSearchProperties ( const Mantid::API::IAlgorithm_sptr &  catalogAlgorithm, const std::map< std::string, std::string > &  userInputFields  )

private

Set the "search" properties to their related input fields.

showLoginDialog()

void MantidQt::MantidWidgets::CatalogHelper::showLoginDialog

(

)

Executes the catalog login algorithm dialog, returning immediately.

showPublishDialog()

void MantidQt::MantidWidgets::CatalogHelper::showPublishDialog

(

)

Create a publishing dialog.

validateProperties()

const std::map< std::string, std::string > MantidQt::MantidWidgets::CatalogHelper::validateProperties

(

const std::map< std::string, std::string > &

inputFields

)

Validate each input field against the related algorithm property.

---

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

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