Add ConfigService.keys() function

Refs #9067
mantidproject · Apr 15, 2015 · 93d8524 · 93d8524
1 parent c96aaa6
commit 93d8524
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h b/Code/Mantid/Framework/Kernel/inc/MantidKernel/ConfigService.h
@@ -132,6 +132,8 @@ class MANTID_KERNEL_DLL ConfigServiceImpl {
                         bool use_cache = true) const;
   /// Searches for a key in the configuration property
   std::vector<std::string> getKeys(const std::string &keyName) const;
+  /// Returns a list of all keys in the configuration property
+  std::vector<std::string> keys() const;
   /// Removes the value from a selected keyName
   void remove(const std::string &rootName) const;
   /// Checks to see whether a key has a value assigned to it

diff --git a/Code/Mantid/Framework/Kernel/src/ConfigService.cpp b/Code/Mantid/Framework/Kernel/src/ConfigService.cpp
@@ -1000,6 +1000,28 @@ ConfigServiceImpl::getKeys(const std::string &keyName) const {
   return keyVector;
 }
 
+/**
+ * Gets a list of all config options as property.key.
+ *
+ * @return Vector containing all config options
+ */
+std::vector<std::string> ConfigServiceImpl::keys() const {
+  std::vector<std::string> rootKeys;
+  m_pConf->keys(rootKeys);
+
+  std::vector<std::string> allKeys;
+  for(auto rkIt = rootKeys.begin(); rkIt != rootKeys.end(); ++rkIt) {
+    std::vector<std::string> subKeys;
+    m_pConf->keys(*rkIt, subKeys);
+
+    for(auto skIt = subKeys.begin(); skIt != subKeys.end(); ++skIt) {
+      allKeys.push_back(*riIt + "." + *skIt);
+    }
+  }
+
+  return allKeys;
+}
+
 /** Removes a key from the memory stored properties file and inserts the key
  *into the
  *  changed key list so that when the program calls saveConfig the properties

diff --git a/Code/Mantid/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp b/Code/Mantid/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp
@@ -98,6 +98,8 @@ void export_ConfigService()
 
     .def("saveConfig", &ConfigServiceImpl::saveConfig, "Saves the keys that have changed from their default to the given filename")
 
+    .def("keys", &ConfigServiceImpl::keys)
+
     // Treat this as a dictionary
     .def("__getitem__", &getStringUsingCache)
     .def("__setitem__", &ConfigServiceImpl::setString)