src/core/config/ConfigManager.hpp

Interface to the main configuration and its normal and special sections. More…

Namespaces

Name
allpix
Helper class to hold support layers for a detector model.

Classes

Name
class allpix::ConfigManager
Manager responsible for loading and providing access to the main configuration.

Detailed Description

Interface to the main configuration and its normal and special sections.

Copyright: Copyright (c) 2017-2024 CERN and the Allpix Squared authors. This software is distributed under the terms of the MIT License, copied verbatim in the file “LICENSE.md”. In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction. SPDX-License-Identifier: MIT

Source code


#ifndef ALLPIX_CONFIG_MANAGER_H
#define ALLPIX_CONFIG_MANAGER_H

#include <filesystem>
#include <set>
#include <string>
#include <vector>

#include "ConfigReader.hpp"
#include "Configuration.hpp"
#include "OptionParser.hpp"
#include "core/module/ModuleIdentifier.hpp"

namespace allpix {

    class ConfigManager {
    public:
        explicit ConfigManager(std::filesystem::path file_name,
                               std::initializer_list<std::string> global = {},
                               std::initializer_list<std::string> ignore = {"Ignore"});
        ~ConfigManager() = default;


        ConfigManager(const ConfigManager&) = delete;
        ConfigManager& operator=(const ConfigManager&) = delete;


        ConfigManager(ConfigManager&&) noexcept = default;
        ConfigManager& operator=(ConfigManager&&) noexcept = default;

        Configuration& getGlobalConfiguration() { return global_config_; }
        std::list<Configuration>& getModuleConfigurations() { return module_configs_; }

        Configuration& addInstanceConfiguration(const ModuleIdentifier& identifier, const Configuration& config);
        const std::list<Configuration>& getInstanceConfigurations() const { return instance_configs_; }

        void dropInstanceConfiguration(const ModuleIdentifier& identifier);

        bool loadModuleOptions(const std::vector<std::string>& options);
        std::list<Configuration>& getDetectorConfigurations();

        bool loadDetectorOptions(const std::vector<std::string>& options);

    private:
        std::set<std::string> global_names_{};
        std::set<std::string> ignore_names_{};

        OptionParser module_option_parser_;

        std::list<Configuration> module_configs_;
        Configuration global_config_;

        // Helper function for delayed parsing of detectors file
        void parse_detectors();
        std::list<Configuration> detector_configs_;

        std::list<Configuration> instance_configs_;
        std::map<ModuleIdentifier, std::list<Configuration>::iterator> instance_identifier_to_config_;
    };
} // namespace allpix

#endif /* ALLPIX_CONFIG_MANAGER_H */

Updated on 2025-04-11 at 14:31:45 +0000