Mantid::API::CatalogSession Class Reference

This class is a responsible for storing session information for a specific catalog. More...

#include <CatalogSession.h>

Public Member Functions
	CatalogSession (std::string sessionID, std::string facility, std::string endpoint)
	Initialise the related catalog session variables. More...
const std::string &	getFacility () const
	Obtain the facility of the catalog created. More...
std::string	getSessionId () const
	Obtain the session ID for the catalog created. More...
const std::string &	getSoapEndpoint () const
	Obtains the soap end-point of the catalog created. More...
void	setSessionId (const std::string &sessionID)
	Used to clear the session ID on logout. More...

Private Attributes
std::string	m_endpoint
std::string	m_facility
std::string	m_sessionID

Detailed Description

This class is a responsible for storing session information for a specific catalog.

Author

Jay Rainey, ISIS Rutherford Appleton Laboratory

Date

27/02/2014

Definition at line 22 of file CatalogSession.h.

Constructor & Destructor Documentation

CatalogSession()

Mantid::API::CatalogSession::CatalogSession	(	std::string	sessionID,
		std::string	facility,
		std::string	endpoint
	)

Initialise the related catalog session variables.

Parameters

sessionID	:: The session ID generated from logging into the catalog.
facility	:: The facility of the catalog the user logged in to.
endpoint	:: The endpoint of the catalog the user logged in to.

Definition at line 19 of file CatalogSession.cpp.

Member Function Documentation

getFacility()

const std::string & Mantid::API::CatalogSession::getFacility

(

)

const

Obtain the facility of the catalog created.

Returns

The facility used to create the catalog.

Definition at line 44 of file CatalogSession.cpp.

References m_facility.

getSessionId()

std::string Mantid::API::CatalogSession::getSessionId

(

)

const

Obtain the session ID for the catalog created.

Returns

The sesssion Id of the catalog created.

Definition at line 26 of file CatalogSession.cpp.

References m_sessionID.

Referenced by export_CatalogSession().

getSoapEndpoint()

const std::string & Mantid::API::CatalogSession::getSoapEndpoint

(

)

const

Obtains the soap end-point of the catalog created.

Returns

The soap end-point used to create the catalog.

Definition at line 38 of file CatalogSession.cpp.

References m_endpoint.

setSessionId()

void Mantid::API::CatalogSession::setSessionId

(

const std::string &

sessionID

)

Used to clear the session ID on logout.

Parameters

sessionID

:: The value to set the session id.

Definition at line 32 of file CatalogSession.cpp.

References m_sessionID.

Member Data Documentation

m_endpoint

std::string Mantid::API::CatalogSession::m_endpoint

private

Definition at line 33 of file CatalogSession.h.

Referenced by getSoapEndpoint().

m_facility

std::string Mantid::API::CatalogSession::m_facility

private

Definition at line 32 of file CatalogSession.h.

Referenced by getFacility().

m_sessionID

std::string Mantid::API::CatalogSession::m_sessionID

private

Definition at line 31 of file CatalogSession.h.

Referenced by getSessionId(), and setSessionId().

---

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

• Framework/API/inc/MantidAPI/CatalogSession.h
• Framework/API/src/CatalogSession.cpp