Mantid::API::ICatalog Class Reference

This class creates an interface for information catalogs to support multiple facilities. More...

#include <ICatalog.h>

Inheritance diagram for Mantid::API::ICatalog:

Public Member Functions
virtual void	getDataFiles (const std::string &, ITableWorkspace_sptr &)=0
	get datafiles More...
virtual void	getDataSets (const std::string &, ITableWorkspace_sptr &)=0
	get datasets. More...
virtual int64_t	getNumberOfSearchResults (const ICat::CatalogSearchParam &)=0
	Obtain the number of results returned by the search method. More...
virtual void	keepAlive ()=0
	keep alive More...
virtual void	listInstruments (std::vector< std::string > &)=0
	instrument list More...
virtual void	listInvestigationTypes (std::vector< std::string > &)=0
	get investigationtype lists More...
virtual CatalogSession_sptr	login (const std::string &, const std::string &, const std::string &, const std::string &)=0
	method to login to a catalog More...
virtual void	logout ()=0
	logout from catalog More...
virtual void	myData (ITableWorkspace_sptr &)=0
	search logged in users data More...
virtual void	search (const ICat::CatalogSearchParam &, ITableWorkspace_sptr &, const int &, const int &)=0
	Search investigations. More...
virtual	~ICatalog ()=default
	Virtual destructor. More...

Detailed Description

This class creates an interface for information catalogs to support multiple facilities.

Author

Sofia Antony, ISIS Rutherford Appleton Laboratory

Date

23/09/2010

Definition at line 28 of file ICatalog.h.

Constructor & Destructor Documentation

~ICatalog()

virtual Mantid::API::ICatalog::~ICatalog ( )

virtualdefault

Virtual destructor.

Member Function Documentation

getDataFiles()

virtual void Mantid::API::ICatalog::getDataFiles ( const std::string &  , ITableWorkspace_sptr &    )

pure virtual

get datafiles

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

getDataSets()

virtual void Mantid::API::ICatalog::getDataSets ( const std::string &  , ITableWorkspace_sptr &    )

pure virtual

get datasets.

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

getNumberOfSearchResults()

virtual int64_t Mantid::API::ICatalog::getNumberOfSearchResults ( const ICat::CatalogSearchParam &  )

pure virtual

Obtain the number of results returned by the search method.

Implemented in Mantid::ICat::ICat4Catalog, and Mantid::API::CompositeCatalog.

keepAlive()

virtual void Mantid::API::ICatalog::keepAlive ( )

pure virtual

keep alive

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

listInstruments()

virtual void Mantid::API::ICatalog::listInstruments ( std::vector< std::string > &  )

pure virtual

instrument list

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

listInvestigationTypes()

virtual void Mantid::API::ICatalog::listInvestigationTypes ( std::vector< std::string > &  )

pure virtual

get investigationtype lists

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

login()

virtual CatalogSession_sptr Mantid::API::ICatalog::login ( const std::string &  , const std::string &  , const std::string &  , const std::string &    )

pure virtual

method to login to a catalog

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

logout()

virtual void Mantid::API::ICatalog::logout ( )

pure virtual

logout from catalog

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

myData()

virtual void Mantid::API::ICatalog::myData ( ITableWorkspace_sptr &  )

pure virtual

search logged in users data

Implemented in Mantid::API::CompositeCatalog, and Mantid::ICat::ICat4Catalog.

search()

virtual void Mantid::API::ICatalog::search ( const ICat::CatalogSearchParam &  , ITableWorkspace_sptr &  , const int &  , const int &    )

pure virtual

Search investigations.

Implemented in Mantid::ICat::ICat4Catalog, and Mantid::API::CompositeCatalog.

---

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

• Framework/API/inc/MantidAPI/ICatalog.h