ConfigManager.hpp

Go to the documentation of this file.

// This file is part of INSTINCT, the INS Toolkit for Integrated
// Navigation Concepts and Training by the Institute of Navigation of
// the University of Stuttgart, Germany.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
/// @file ConfigManager.hpp
/// @brief Config management for the Project
/// @author T. Topp (topp@ins.uni-stuttgart.de)
/// @date 2020-03-11
 
#pragma once
 
#include <vector>
#include <string>
#include <deque>
#include <memory>
 
#include <boost/program_options/options_description.hpp>
#include <boost/program_options/variables_map.hpp>
 
#include <fmt/core.h>
 
namespace NAV::ConfigManager
{
/// Map which stores all options
extern boost::program_options::variables_map vm;
 
/// @brief Initializes the config manager. Call this function before using other functions
void initialize();
 
/// @brief Deinitializes the config manager. Call this if you want to Fetch config again
void deinitialize();
 
/// @brief Get the Program Options object
/// @return The object
[[nodiscard]] const boost::program_options::options_description& GetProgramOptions();
 
/// @brief Fetches the configs from the command line parameters
/// @param[in] argc Number of command line parameters
/// @param[in] argv Array of the command line parameters
/// @return List of config files which failed to be read (for error reporting)
std::vector<std::string> FetchConfigs(const int argc, const char* argv[]); // NOLINT
 
/// @brief Writes all command line options into the log
/// @param[in] argc Number of command line parameters
/// @param[in] argv Array of the command line parameters
void CheckOptions(const int argc, const char* argv[]); // NOLINT
 
/// @brief Retrieves the value of a corresponding key from the configuration, if one exists.
/// @tparam T Return value type
/// @param[in] key Key to search for
/// @param[in] defaultValue If key is not found, the default value is returned
/// @return The value found with the key or the default value
template<typename T>
const T& Get(const std::string& key, const T&& defaultValue)
{
    if (vm.count(key))
    {
        return vm[key].as<T>();
    }
 
    return defaultValue;
}
 
/// @brief Retrieves the value of a corresponding key from the configuration, if it does not exists, throws an exception
/// @tparam T Return value type
/// @param[in] key Key to search for
/// @return The value found with the key
template<typename T>
const T& Get(const std::string& key)
{
    if (vm.count(key))
    {
        return vm[key].as<T>();
    }
 
    throw std::runtime_error(fmt::format("The key '{}' does not exist.", key));
}
 
/// Checks if a corresponding key exists in the configuration.
bool HasKey(const std::string& key);
 
/// Returns all keys in the configuration, as a vector.
std::vector<std::string> GetKeys();
 
/// @brief Saves the global settings
void SaveGlobalSettings();
 
/// @brief Loads the global settings
void LoadGlobalSettings();
 
} // namespace NAV::ConfigManager