Storm
A Modern Probabilistic Model Checker
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
storm::settings::modules::GeneralSettings Class Reference

This class represents the general settings. More...

#include <GeneralSettings.h>

Inheritance diagram for storm::settings::modules::GeneralSettings:
Inheritance graph
[legend]
Collaboration diagram for storm::settings::modules::GeneralSettings:
Collaboration graph
[legend]

Public Member Functions

 GeneralSettings ()
 Creates a new set of general settings.
 
bool isHelpSet () const
 Retrieves whether the help option was set.
 
bool isVersionSet () const
 Retrieves whether the version option was set.
 
std::string getHelpFilterExpression () const
 Retrieves the name of the module for which to show the help or "all" to indicate that the full help needs to be shown.
 
bool isVerboseSet () const
 Retrieves whether the verbose option was set.
 
bool isShowProgressSet () const
 Retrieves whether the progress option was set.
 
uint64_t getShowProgressDelay () const
 Retrieves the delay for printing information about the exploration progress.
 
double getPrecision () const
 Retrieves the precision to use for numerical operations.
 
bool isConfigSet () const
 Retrieves whether the config option was set.
 
std::string getConfigFilename () const
 Retrieves the name of the file that is to be scanned for settings.
 
bool isBisimulationSet () const
 Retrieves whether the option to perform bisimulation minimization is set.
 
bool isParametricSet () const
 Retrieves whether the option enabling parametric model checking is set.
 
bool isPrecisionSet () const
 
void setPrecision (std::string precision)
 
bool isExactSet () const
 Retrieves whether the option enabling exact model checking is set and we should use infinite precision rationals.
 
bool isExactFinitePrecisionSet () const
 Retrieves whether the option enabling exact model checking is set.
 
bool isSoundSet () const
 Retrieves whether the option forcing soundnet is set.
 
bool check () const override
 Checks whether the settings are consistent.
 
void finalize () override
 Prepares the modules for further usage, should be called at the end of the initialization, before checks are executed.
 
- Public Member Functions inherited from storm::settings::modules::ModuleSettings
 ModuleSettings (std::string const &moduleName)
 Constructs a new settings object.
 
virtual ~ModuleSettings ()
 
std::unique_ptr< storm::settings::SettingMemento > overrideOption (std::string const &name, bool requiredStatus)
 Sets the option with the given name to the required status.
 
std::string const & getModuleName () const
 Retrieves the name of the module to which these settings belong.
 
std::vector< std::shared_ptr< Option > > const & getOptions () const
 Retrieves the options of this module.
 
uint_fast64_t getPrintLengthOfLongestOption (bool includeAdvanced) const
 Retrieves the (print) length of the longest option.
 
void restoreDefaults ()
 Restores the default values for all arguments of all options.
 

Static Public Attributes

static const std::string moduleName = "general"
 

Additional Inherited Members

- Protected Member Functions inherited from storm::settings::modules::ModuleSettings
Option & getOption (std::string const &longName)
 Retrieves the option with the given long name.
 
Option const & getOption (std::string const &longName) const
 Retrieves the option with the given long name.
 
bool isSet (std::string const &optionName) const
 Retrieves whether the option with the given name was set.
 
void set (std::string const &name)
 Sets the option with the specified name.
 
void unset (std::string const &name)
 Unsets the option with the specified name.
 
void addOption (std::shared_ptr< Option > const &option)
 Adds and registers the given option.
 

Detailed Description

This class represents the general settings.

Definition at line 16 of file GeneralSettings.h.

Constructor & Destructor Documentation

◆ GeneralSettings()

storm::settings::modules::GeneralSettings::GeneralSettings ( )

Creates a new set of general settings.

Definition at line 36 of file GeneralSettings.cpp.

Member Function Documentation

◆ check()

bool storm::settings::modules::GeneralSettings::check ( ) const
overridevirtual

Checks whether the settings are consistent.

If they are inconsistent, an exception is thrown.

Returns
True if the settings are consistent.

Reimplemented from storm::settings::modules::ModuleSettings.

Definition at line 159 of file GeneralSettings.cpp.

◆ finalize()

void storm::settings::modules::GeneralSettings::finalize ( )
overridevirtual

Prepares the modules for further usage, should be called at the end of the initialization, before checks are executed.

Reimplemented from storm::settings::modules::ModuleSettings.

Definition at line 155 of file GeneralSettings.cpp.

◆ getConfigFilename()

std::string storm::settings::modules::GeneralSettings::getConfigFilename ( ) const

Retrieves the name of the file that is to be scanned for settings.

Returns
The name of the file that is to be scanned for settings.

Definition at line 129 of file GeneralSettings.cpp.

◆ getHelpFilterExpression()

std::string storm::settings::modules::GeneralSettings::getHelpFilterExpression ( ) const

Retrieves the name of the module for which to show the help or "all" to indicate that the full help needs to be shown.

Returns
The name of the module for which to show the help or "all".

Definition at line 98 of file GeneralSettings.cpp.

◆ getPrecision()

double storm::settings::modules::GeneralSettings::getPrecision ( ) const

Retrieves the precision to use for numerical operations.

Returns
The precision to use for numerical operations.

Definition at line 121 of file GeneralSettings.cpp.

◆ getShowProgressDelay()

uint64_t storm::settings::modules::GeneralSettings::getShowProgressDelay ( ) const

Retrieves the delay for printing information about the exploration progress.

Returns
The desired delay in seconds. If 0, no information about the progress shall be printed.

Definition at line 110 of file GeneralSettings.cpp.

◆ isBisimulationSet()

bool storm::settings::modules::GeneralSettings::isBisimulationSet ( ) const

Retrieves whether the option to perform bisimulation minimization is set.

Returns
True iff the option was set.

Definition at line 133 of file GeneralSettings.cpp.

◆ isConfigSet()

bool storm::settings::modules::GeneralSettings::isConfigSet ( ) const

Retrieves whether the config option was set.

Returns
True if the config option was set.

Definition at line 125 of file GeneralSettings.cpp.

◆ isExactFinitePrecisionSet()

bool storm::settings::modules::GeneralSettings::isExactFinitePrecisionSet ( ) const

Retrieves whether the option enabling exact model checking is set.

Returns
True iff the option was set.

Definition at line 146 of file GeneralSettings.cpp.

◆ isExactSet()

bool storm::settings::modules::GeneralSettings::isExactSet ( ) const

Retrieves whether the option enabling exact model checking is set and we should use infinite precision rationals.

Returns
True iff the option was set.

Definition at line 141 of file GeneralSettings.cpp.

◆ isHelpSet()

bool storm::settings::modules::GeneralSettings::isHelpSet ( ) const

Retrieves whether the help option was set.

Returns
True if the help option was set.

Definition at line 90 of file GeneralSettings.cpp.

◆ isParametricSet()

bool storm::settings::modules::GeneralSettings::isParametricSet ( ) const

Retrieves whether the option enabling parametric model checking is set.

Returns
True iff the option was set.

Definition at line 137 of file GeneralSettings.cpp.

◆ isPrecisionSet()

bool storm::settings::modules::GeneralSettings::isPrecisionSet ( ) const

Definition at line 114 of file GeneralSettings.cpp.

◆ isShowProgressSet()

bool storm::settings::modules::GeneralSettings::isShowProgressSet ( ) const

Retrieves whether the progress option was set.

Returns
True if the progress option was set.

Definition at line 106 of file GeneralSettings.cpp.

◆ isSoundSet()

bool storm::settings::modules::GeneralSettings::isSoundSet ( ) const

Retrieves whether the option forcing soundnet is set.

Returns
True iff the option was set.

Definition at line 151 of file GeneralSettings.cpp.

◆ isVerboseSet()

bool storm::settings::modules::GeneralSettings::isVerboseSet ( ) const

Retrieves whether the verbose option was set.

Returns
True if the verbose option was set.

Definition at line 102 of file GeneralSettings.cpp.

◆ isVersionSet()

bool storm::settings::modules::GeneralSettings::isVersionSet ( ) const

Retrieves whether the version option was set.

Returns
True if the version option was set.

Definition at line 94 of file GeneralSettings.cpp.

◆ setPrecision()

void storm::settings::modules::GeneralSettings::setPrecision ( std::string  precision)

Definition at line 118 of file GeneralSettings.cpp.

Member Data Documentation

◆ moduleName

const std::string storm::settings::modules::GeneralSettings::moduleName = "general"
static

Definition at line 130 of file GeneralSettings.h.

The documentation for this class was generated from the following files: