ModuleSettings.h

Go to the documentation of this file.

#ifndef STORM_SETTINGS_MODULES_MODULESETTINGS_H_
#define STORM_SETTINGS_MODULES_MODULESETTINGS_H_
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace storm {
namespace settings {
// Forward-declare some classes.
class SettingsManager;
class SettingMemento;
class Option;
 
namespace modules {
 
class ModuleSettings {
   public:
    // Declare the memento class as a friend so it can manipulate the internal state.
    friend class storm::settings::SettingMemento;
 
    ModuleSettings(std::string const& moduleName);
    virtual ~ModuleSettings() {}
 
    virtual bool check() const;
 
    virtual void finalize();
 
    std::unique_ptr<storm::settings::SettingMemento> overrideOption(std::string const& name, bool requiredStatus);
 
    std::string const& getModuleName() const;
 
    std::vector<std::shared_ptr<Option>> const& getOptions() const;
 
    uint_fast64_t getPrintLengthOfLongestOption(bool includeAdvanced) const;
 
    void restoreDefaults();
 
   protected:
    Option& getOption(std::string const& longName);
 
    Option const& getOption(std::string const& longName) const;
 
    bool isSet(std::string const& optionName) const;
 
    void set(std::string const& name);
 
    void unset(std::string const& name);
 
    void addOption(std::shared_ptr<Option> const& option);
 
   private:
    // The name of the module.
    std::string moduleName;
 
    // A mapping of option names of the module to the actual options.
    std::unordered_map<std::string, std::shared_ptr<Option>> optionMap;
 
    // The list of known option names in the order they were registered.
    std::vector<std::shared_ptr<Option>> options;
};
 
}  // namespace modules
}  // namespace settings
}  // namespace storm
 
#endif /* STORM_SETTINGS_MODULES_MODULESETTINGS_H_ */