This class represents the settings for Sylvan. More...

#include <SylvanSettings.h>

Inheritance diagram for storm::settings::modules::SylvanSettings:

Collaboration diagram for storm::settings::modules::SylvanSettings:

Public Member Functions
	SylvanSettings ()
	Creates a new set of Sylvan settings.

uint_fast64_t	getMaximalMemory () const
	Retrieves the maximal amount of memory (in megabytes) that Sylvan can occupy.

uint_fast64_t	getNumberOfThreads () const
	Retrieves the amount of threads available to Sylvan.

bool	isNumberOfThreadsSet () const
	Retrieves whether the number of threads to use was set.

bool	check () const override
	Checks whether the settings are consistent.

Public Member Functions inherited from storm::settings::modules::ModuleSettings
	ModuleSettings (std::string const &moduleName)
	Constructs a new settings object.

virtual	~ModuleSettings ()

virtual void	finalize ()
	Prepares the modules for further usage, should be called at the end of the initialization, before checks are executed.

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 = "sylvan"

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 settings for Sylvan.

Definition at line 13 of file SylvanSettings.h.

Constructor & Destructor Documentation

◆ SylvanSettings()

storm::settings::modules::SylvanSettings::SylvanSettings ( )

Creates a new set of Sylvan settings.

Definition at line 19 of file SylvanSettings.cpp.

Member Function Documentation

◆ check()

bool storm::settings::modules::SylvanSettings::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 58 of file SylvanSettings.cpp.

◆ getMaximalMemory()

uint_fast64_t storm::settings::modules::SylvanSettings::getMaximalMemory ( ) const

Retrieves the maximal amount of memory (in megabytes) that Sylvan can occupy.

Returns: The maximal amount of memory to use.

Definition at line 34 of file SylvanSettings.cpp.

◆ getNumberOfThreads()

uint_fast64_t storm::settings::modules::SylvanSettings::getNumberOfThreads ( ) const

Retrieves the amount of threads available to Sylvan.

Note that a value of zero means that the number of threads is auto-detected to fit the current machine.

@rreturn The number of threads.

Definition at line 42 of file SylvanSettings.cpp.

◆ isNumberOfThreadsSet()

bool storm::settings::modules::SylvanSettings::isNumberOfThreadsSet ( ) const

Retrieves whether the number of threads to use was set.

Definition at line 38 of file SylvanSettings.cpp.

Member Data Documentation

◆ moduleName

const std::string storm::settings::modules::SylvanSettings::moduleName = "sylvan"

static

Definition at line 43 of file SylvanSettings.h.

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

src/storm/settings/modules/SylvanSettings.h
src/storm/settings/modules/SylvanSettings.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members