#include <ISISInstrumentDataCache.h>

Public Member Functions
std::string	getFileParentDirectoryPath (const std::string &filename) const

std::vector< std::string >	getRunNumbersInCache (std::string const &instrumentName) const
	Get a vector of the run numbers' files present in the given instrument's data cache.

bool	isIndexFileAvailable (std::string const &instrument) const
	Check if the data cache index file is available on the current system for a given instrument.

	ISISInstrumentDataCache (const std::string &path)

Private Member Functions
Mantid::Kernel::InstrumentInfo	getInstrumentFromName (const std::string &instName) const

std::filesystem::path	makeIndexFilePath (const std::string &instrumentName) const

std::pair< std::filesystem::path, Json::Value >	openCacheJsonFile (const Mantid::Kernel::InstrumentInfo &instrument) const
	Open the Json file and return the path and the opened file object.

std::pair< std::string, std::string >	splitIntoInstrumentAndNumber (const std::string &filename) const

std::pair< Mantid::Kernel::InstrumentInfo, std::string >	validateInstrumentAndNumber (const std::string &filename) const

Private Attributes
std::string	m_dataCachePath

Detailed Description

Definition at line 22 of file ISISInstrumentDataCache.h.

Constructor & Destructor Documentation

◆ ISISInstrumentDataCache()

Mantid::API::ISISInstrumentDataCache::ISISInstrumentDataCache ( const std::string & path )

inline

Definition at line 24 of file ISISInstrumentDataCache.h.

Member Function Documentation

◆ getFileParentDirectoryPath()

std::string ISISInstrumentDataCache::getFileParentDirectoryPath ( const std::string & filename ) const

Definition at line 23 of file ISISInstrumentDataCache.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, openCacheJsonFile(), and validateInstrumentAndNumber().

◆ getInstrumentFromName()

InstrumentInfo ISISInstrumentDataCache::getInstrumentFromName ( const std::string & instName ) const

private

Definition at line 99 of file ISISInstrumentDataCache.cpp.

Referenced by getRunNumbersInCache(), and validateInstrumentAndNumber().

◆ getRunNumbersInCache()

std::vector< std::string > ISISInstrumentDataCache::getRunNumbersInCache ( std::string const & instrumentName ) const

Get a vector of the run numbers' files present in the given instrument's data cache.

Parameters

instrumentName The instrument to get run numbers for.

Returns: A vector containing the run numbers that can be accessed from the data cache.

Definition at line 49 of file ISISInstrumentDataCache.cpp.

References getInstrumentFromName(), and openCacheJsonFile().

◆ isIndexFileAvailable()

bool ISISInstrumentDataCache::isIndexFileAvailable ( std::string const & instrumentName ) const

Check if the data cache index file is available on the current system for a given instrument.

Parameters

instrumentName The instrument to find the index file for.

Returns: if there is an index file (and therefore instrument data cache) on the system.

Definition at line 135 of file ISISInstrumentDataCache.cpp.

References makeIndexFilePath().

◆ makeIndexFilePath()

std::filesystem::path ISISInstrumentDataCache::makeIndexFilePath ( const std::string & instrumentName ) const

private

Definition at line 108 of file ISISInstrumentDataCache.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::g_log, and m_dataCachePath.

Referenced by isIndexFileAvailable(), and openCacheJsonFile().

◆ openCacheJsonFile()

std::pair< std::filesystem::path, Json::Value > ISISInstrumentDataCache::openCacheJsonFile ( const Mantid::Kernel::InstrumentInfo & instrument ) const

private

Open the Json file and return the path and the opened file object.

Parameters

instrument The instrument to open the index file for.