A class that holds information about catalogs. More...

#include <CatalogInfo.h>

Inheritance diagram for Mantid::Kernel::CatalogInfo:

Public Member Functions
	CatalogInfo (const CatalogInfo &other)
	Copy constructor. More...

	CatalogInfo (const Poco::XML::Element *element)
	Constructor. More...

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...

CatalogInfo *	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...

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 Member Functions
std::string	getAttribute (const Poco::XML::Element *element, const std::string &tagName, const std::string &attributeName)
	Obtain the attribute from a given element tag and attribute name. More...

CatalogInfo &	operator= (const CatalogInfo &other)

Private Attributes
std::string	m_catalogName

std::string	m_catalogPrefix

std::string	m_externalDownloadURL

std::string	m_linuxPrefix

std::string	m_macPrefix

std::string	m_soapEndPoint

std::string	m_windowsPrefix

Detailed Description

A class that holds information about catalogs.

Definition at line 31 of file CatalogInfo.h.

Constructor & Destructor Documentation

◆ CatalogInfo() [1/2]

Mantid::Kernel::CatalogInfo::CatalogInfo ( const Poco::XML::Element * element )

Constructor.

Parameters

element :: "Catalog" element from Facilities.xml

Definition at line 23 of file CatalogInfo.cpp.

References getAttribute(), m_catalogName, m_catalogPrefix, m_externalDownloadURL, m_linuxPrefix, m_macPrefix, m_soapEndPoint, and m_windowsPrefix.

◆ CatalogInfo() [2/2]

Mantid::Kernel::CatalogInfo::CatalogInfo ( const CatalogInfo & other )

Copy constructor.

Definition at line 33 of file CatalogInfo.cpp.

Member Function Documentation

◆ catalogName()

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

overridevirtual

Obtain catalog name from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 41 of file CatalogInfo.cpp.

References m_catalogName.

◆ catalogPrefix()

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

overridevirtual

Obtain the regex prefix from the facility file.

Obtain the regex prefix for default archive path.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 56 of file CatalogInfo.cpp.

References m_catalogPrefix.

◆ clone()

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

overridevirtual

Clone.

Virtual constructor.

Returns: deep copy of this

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 77 of file CatalogInfo.cpp.

◆ externalDownloadURL()

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

overridevirtual

Obtain the external download URL.

Obtain catalog name from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 51 of file CatalogInfo.cpp.

References m_externalDownloadURL.

◆ getAttribute()

std::string Mantid::Kernel::CatalogInfo::getAttribute	(	const Poco::XML::Element *	element,
		const std::string &	tagName,
		const std::string &	attributeName
	)

private

Obtain the attribute from a given element tag and attribute name.

Parameters

element	:: The name of the element in the XML file.
tagName	:: The name of the tag to search for.
attributeName	:: The name of the attribute for the given tag.

Returns: The contents of the attribute from an XML element.

Definition at line 86 of file CatalogInfo.cpp.

Referenced by CatalogInfo().

◆ linuxPrefix()

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

overridevirtual

Obtain Linux prefix from facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 71 of file CatalogInfo.cpp.

References m_linuxPrefix.

◆ macPrefix()

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

overridevirtual

Obtain Macintosh prefix from facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 66 of file CatalogInfo.cpp.

References m_macPrefix.

◆ operator=()

CatalogInfo & Mantid::Kernel::CatalogInfo::operator= ( const CatalogInfo & other )

private

◆ soapEndPoint()

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

overridevirtual

Obtain soap end point from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 46 of file CatalogInfo.cpp.

References m_soapEndPoint.

◆ windowsPrefix()

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

overridevirtual

Obtain Windows prefix from the facility file.

Implements Mantid::Kernel::ICatalogInfo.

Definition at line 61 of file CatalogInfo.cpp.

References m_windowsPrefix.

Member Data Documentation

◆ m_catalogName

std::string Mantid::Kernel::CatalogInfo::m_catalogName

private

Definition at line 62 of file CatalogInfo.h.

Referenced by CatalogInfo(), and catalogName().

◆ m_catalogPrefix

std::string Mantid::Kernel::CatalogInfo::m_catalogPrefix

private

Definition at line 65 of file CatalogInfo.h.

Referenced by CatalogInfo(), and catalogPrefix().

◆ m_externalDownloadURL

std::string Mantid::Kernel::CatalogInfo::m_externalDownloadURL

private

Definition at line 64 of file CatalogInfo.h.

Referenced by CatalogInfo(), and externalDownloadURL().

◆ m_linuxPrefix

std::string Mantid::Kernel::CatalogInfo::m_linuxPrefix

private

Definition at line 68 of file CatalogInfo.h.

Referenced by CatalogInfo(), and linuxPrefix().

◆ m_macPrefix

std::string Mantid::Kernel::CatalogInfo::m_macPrefix

private

Definition at line 67 of file CatalogInfo.h.

Referenced by CatalogInfo(), and macPrefix().

◆ m_soapEndPoint

std::string Mantid::Kernel::CatalogInfo::m_soapEndPoint

private

Definition at line 63 of file CatalogInfo.h.

Referenced by CatalogInfo(), and soapEndPoint().

◆ m_windowsPrefix

std::string Mantid::Kernel::CatalogInfo::m_windowsPrefix

private

Definition at line 66 of file CatalogInfo.h.

Referenced by CatalogInfo(), and windowsPrefix().

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

Framework/Kernel/inc/MantidKernel/CatalogInfo.h
Framework/Kernel/src/CatalogInfo.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CatalogInfo() [1/2]

◆ CatalogInfo() [2/2]

Member Function Documentation

◆ catalogName()

◆ catalogPrefix()

◆ clone()

◆ externalDownloadURL()

◆ getAttribute()

◆ linuxPrefix()

◆ macPrefix()

◆ operator=()

◆ soapEndPoint()

◆ windowsPrefix()

Member Data Documentation

◆ m_catalogName

◆ m_catalogPrefix

◆ m_externalDownloadURL

◆ m_linuxPrefix

◆ m_macPrefix

◆ m_soapEndPoint

◆ m_windowsPrefix