Mantid::Kernel::UserCatalogInfo Class Reference

UserCatalogInfo : Takes catalog info from the facility (via CatalogInfo), but provides the ability to override the facility defaults based on user preferences. More...

#include <UserCatalogInfo.h>

Inheritance diagram for Mantid::Kernel::UserCatalogInfo:

Public Member Functions
const std::string	catalogName () const override
	Obtain catalog name from the facility file. More...
const std::string	catalogPrefix () const override
	Obtain the regex prefix from the facility file. More...
UserCatalogInfo *	clone () const override
	Clone. More...
const std::string	externalDownloadURL () const override
	Obtain the external download URL. More...
const std::string	linuxPrefix () const override
	Obtain Linux prefix from facility file. More...
const std::string	macPrefix () const override
	Obtain Macintosh prefix from facility file. More...
const std::string	soapEndPoint () const override
	Obtain soap end point from the facility file. More...
	UserCatalogInfo (const ICatalogInfo &catInfo, const CatalogConfigService &catalogConfigService)
	UserCatalogInfo (const UserCatalogInfo &other)
const std::string	windowsPrefix () const override
	Obtain Windows prefix from the facility file. More...
Public Member Functions inherited from Mantid::Kernel::ICatalogInfo
virtual const std::string	catalogName () const =0
	Obtain catalog name from the facility file. More...
virtual const std::string	catalogPrefix () const =0
	Obtain the regex prefix from the facility file. More...
virtual ICatalogInfo *	clone () const =0
	Clone. More...
virtual const std::string	externalDownloadURL () const =0
	Obtain the external download URL. More...
virtual const std::string	linuxPrefix () const =0
	Obtain Linux prefix from facility file. More...
virtual const std::string	macPrefix () const =0
	Obtain Macintosh prefix from facility file. More...
virtual const std::string	soapEndPoint () const =0
	Obtain soap end point from the facility file. More...
virtual std::string	transformArchivePath (const std::string &path) const
	Transform's the archive path based on operating system used. More...
virtual const std::string	windowsPrefix () const =0
	Obtain Windows prefix from the facility file. More...
virtual	~ICatalogInfo ()=default
	virtual destructor More...

Private Attributes
const std::unique_ptr< ICatalogInfo >	m_catInfo
	Facility catalog info. Aggregation only solution here. More...
const OptionalPath	m_mountPoint
	Archive mount point. More...

Detailed Description

UserCatalogInfo : Takes catalog info from the facility (via CatalogInfo), but provides the ability to override the facility defaults based on user preferences.

Definition at line 50 of file UserCatalogInfo.h.

Constructor & Destructor Documentation

UserCatalogInfo() [1/2]

Mantid::Kernel::UserCatalogInfo::UserCatalogInfo	(	const ICatalogInfo &	catInfo,
		const CatalogConfigService &	catalogConfigService
	)

Definition at line 11 of file UserCatalogInfo.cpp.

UserCatalogInfo() [2/2]

Mantid::Kernel::UserCatalogInfo::UserCatalogInfo

(

const UserCatalogInfo &

other

)

Definition at line 14 of file UserCatalogInfo.cpp.

Member Function Documentation

catalogName()

const std::string Mantid::Kernel::UserCatalogInfo::catalogName ( ) const

overridevirtual

Obtain catalog name from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 17 of file UserCatalogInfo.cpp.

References m_catInfo.

catalogPrefix()

const std::string Mantid::Kernel::UserCatalogInfo::catalogPrefix ( ) const

overridevirtual

Obtain the regex prefix from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 23 of file UserCatalogInfo.cpp.

References m_catInfo.

clone()

UserCatalogInfo * Mantid::Kernel::UserCatalogInfo::clone ( ) const

overridevirtual

Clone.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 46 of file UserCatalogInfo.cpp.

externalDownloadURL()

const std::string Mantid::Kernel::UserCatalogInfo::externalDownloadURL ( ) const

overridevirtual

Obtain the external download URL.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 21 of file UserCatalogInfo.cpp.

References m_catInfo.

linuxPrefix()

const std::string Mantid::Kernel::UserCatalogInfo::linuxPrefix ( ) const

overridevirtual

Obtain Linux prefix from facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 39 of file UserCatalogInfo.cpp.

References m_catInfo, and m_mountPoint.

macPrefix()

const std::string Mantid::Kernel::UserCatalogInfo::macPrefix ( ) const

overridevirtual

Obtain Macintosh prefix from facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 32 of file UserCatalogInfo.cpp.

References m_catInfo, and m_mountPoint.

Referenced by Mantid::ICat::CatalogDownloadDataFiles::exec().

soapEndPoint()

const std::string Mantid::Kernel::UserCatalogInfo::soapEndPoint ( ) const

overridevirtual

Obtain soap end point from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 19 of file UserCatalogInfo.cpp.

References m_catInfo.

windowsPrefix()

const std::string Mantid::Kernel::UserCatalogInfo::windowsPrefix ( ) const

overridevirtual

Obtain Windows prefix from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 25 of file UserCatalogInfo.cpp.

References m_catInfo, and m_mountPoint.

Member Data Documentation

m_catInfo

const std::unique_ptr<ICatalogInfo> Mantid::Kernel::UserCatalogInfo::m_catInfo

private

Facility catalog info. Aggregation only solution here.

Definition at line 68 of file UserCatalogInfo.h.

Referenced by catalogName(), catalogPrefix(), externalDownloadURL(), linuxPrefix(), macPrefix(), soapEndPoint(), and windowsPrefix().

m_mountPoint

const OptionalPath Mantid::Kernel::UserCatalogInfo::m_mountPoint

private

Archive mount point.

Definition at line 70 of file UserCatalogInfo.h.

Referenced by linuxPrefix(), macPrefix(), and windowsPrefix().

---

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

• Framework/Kernel/inc/MantidKernel/UserCatalogInfo.h
• Framework/Kernel/src/UserCatalogInfo.cpp