ConfigServiceImpl¶

This a python binding to the C++ class Mantid::Kernel::ConfigServiceImpl.

class mantid.kernel.ConfigServiceImpl¶

Instance() → ConfigServiceImpl :¶

Returns a reference to the ConfigService

__init__()¶

Raises an exception This class cannot be instantiated from Python

appendDataSearchDir((ConfigServiceImpl)arg1, (str)arg2) → None :¶

Append a directory to the current list of data search paths

getDataSearchDirs((ConfigServiceImpl)arg1) → std_vector_str :¶

Return the current list of data search paths

getFacilities((ConfigServiceImpl)arg1) → std_vector_facilityinfo :¶

Returns the default facility

getFacility((ConfigServiceImpl)arg1) → FacilityInfo :¶

Returns the default facility

getFacility( (ConfigServiceImpl)arg1, (str)facilityName) -> FacilityInfo :

Returns the named facility. Raises an RuntimeError if it does not exist

getFacilityNames((ConfigServiceImpl)arg1) → std_vector_str :¶

Returns the default facility

getInstrument((ConfigServiceImpl)arg1[, (str)instrumentName='']) → InstrumentInfo :¶

Returns the named instrument. If name = “” then the default.instrument is returned

getInstrumentDirectories((ConfigServiceImpl)arg1) → std_vector_str :¶

Returns the list of directories searched for the instrument definitions

getInstrumentDirectory((ConfigServiceImpl)arg1) → str :¶

Returns the directory used for the instrument definitions

getLocalFilename((ConfigServiceImpl)arg1) → str :¶

Returns the path to the system wide properties file.

getString((ConfigServiceImpl)arg1, (str)key[, (bool)use_cache=True]) → str :¶

Returns the named key’s value. If use_cache = true [default] then relative paths->absolute

getUserFilename((ConfigServiceImpl)arg1) → str :¶

Returns the path to the user properties file

hasProperty((ConfigServiceImpl)arg1, (str)arg2) → bool¶

keys((ConfigServiceImpl)arg1) → std_vector_str¶

reset((ConfigServiceImpl)arg1) → None :¶

Clears all user settings and removes the user properties file

saveConfig((ConfigServiceImpl)arg1, (str)arg2) → None :¶

Saves the keys that have changed from their default to the given filename

setConsoleLogLevel((ConfigServiceImpl)arg1, (int)arg2) → None :¶

Sets the log level priority for the Console log channel, logLevel 1 = Fatal, 6 = information, 7 = Debug

setDataSearchDirs((ConfigServiceImpl)arg1, (str)arg2) → None :¶

Set the whole datasearch.directories property from a single string. Entries should be separated by a ; character

setDataSearchDirs( (ConfigServiceImpl)arg1, (list)arg2) -> None :

Set the datasearch.directories property from a list of strings.

setFacility((ConfigServiceImpl)arg1, (str)arg2) → None :¶

Sets the current facility to the given name

setFileLogLevel((ConfigServiceImpl)arg1, (int)arg2) → None :¶

Sets the log level priority for the File log channel, logLevel 1 = Fatal, 6 = information, 7 = Debug

setString((ConfigServiceImpl)arg1, (str)arg2, (str)arg3) → None :¶

Set the given property name. If it does not exist it is added to the current configuration

updateFacilities((ConfigServiceImpl)arg1, (str)arg2) → None :¶

Loads facility information from a provided file