Option.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <iostream>
#include <memory>
#include <string>
#include <vector>
 
#include <unordered_map>
 
#include "ArgumentBase.h"
 
namespace storm {
namespace settings {
 
// Forward-declare settings manager and module settings classes.
class SettingsManager;
namespace modules {
class ModuleSettings;
}
class ArgumentBase;

class Option {
   public:
    // Declare settings manager and module settings classes as friends.
    friend class SettingsManager;
    friend class modules::ModuleSettings;

    Option(std::string const& moduleName, std::string const& longOptionName, std::string const& optionDescription, bool isOptionRequired,
           bool requireModulePrefix, bool isAdvanced,
           std::vector<std::shared_ptr<ArgumentBase>> const& optionArguments = std::vector<std::shared_ptr<ArgumentBase>>());

    Option(std::string const& moduleName, std::string const& longOptionName, std::string const& shortOptionName, std::string const& optionDescription,
           bool isOptionRequired, bool requireModulePrefix, bool isAdvanced,
           std::vector<std::shared_ptr<ArgumentBase>> const& optionArguments = std::vector<std::shared_ptr<ArgumentBase>>());

    bool isCompatibleWith(Option const& other);

    uint_fast64_t getArgumentCount() const;

    ArgumentBase const& getArgument(uint_fast64_t argumentIndex) const;

    ArgumentBase& getArgument(uint_fast64_t argumentIndex);

    ArgumentBase const& getArgumentByName(std::string const& argumentName) const;

    ArgumentBase& getArgumentByName(std::string const& argumentName);

    std::string const& getLongName() const;

    bool getHasShortName() const;

    std::string const& getShortName() const;

    std::string const& getDescription() const;

    std::string const& getModuleName() const;

    bool getIsRequired() const;

    bool getRequiresModulePrefix() const;

    bool getHasOptionBeenSet() const;

    bool getHasOptionBeenSetWithModulePrefix() const;

    bool getIsAdvanced() const;

    std::vector<std::shared_ptr<ArgumentBase>> const& getArguments() const;

    uint_fast64_t getPrintLength() const;
 
    friend std::ostream& operator<<(std::ostream& out, Option const& option);
 
   private:
    // The long name of the option.
    std::string longName;
 
    // A flag that indicates whether the option has a short name.
    bool hasShortName;
 
    // The short name of the option if any is set and an empty string otherwise.
    std::string shortName;
 
    // The description of the option.
    std::string description;
 
    // The name of the module to which this option belongs.
    std::string moduleName;
 
    // A flag that indicates whether this option is required to appear.
    bool isRequired;
 
    // A flag that indicates whether this option is required to be prefixed with the module name.
    bool requireModulePrefix;
 
    // A flag that indicates whether this option is only displayed in the advanced help.
    bool isAdvanced;
 
    // A flag that indicates whether this option has been set.
    bool hasBeenSet;
 
    // A flag that indicates whether this option has been set.
    bool hasBeenSetWithModulePrefix;
 
    // The arguments of this option (possibly empty).
    std::vector<std::shared_ptr<ArgumentBase>> arguments;
 
    // A mapping from argument names of this option to the actual arguments.
    std::unordered_map<std::string, std::shared_ptr<ArgumentBase>> argumentNameMap;

    Option(std::string const& moduleName, std::string const& longOptionName, std::string const& shortOptionName, bool hasShortOptionName,
           std::string const& optionDescription, bool isOptionRequired, bool requireModulePrefix, bool isAdvanced,
           std::vector<std::shared_ptr<ArgumentBase>> const& optionArguments = std::vector<std::shared_ptr<ArgumentBase>>());

    void setHasOptionBeenSet(bool newValue = true);

    void setHasOptionBeenSetWithModulePrefix(bool newValue = true);
};
}  // namespace settings
}  // namespace storm