This class represents the resource settings. More...

#include <ResourceSettings.h>

Inheritance diagram for storm::settings::modules::ResourceSettings:

Collaboration diagram for storm::settings::modules::ResourceSettings:

Public Member Functions
	ResourceSettings ()
	Creates a new set of general settings.

bool	isPrintTimeAndMemorySet () const
	Retrieves whether time and memory consumption shall be printed at the end of a run.

bool	isTimeoutSet () const
	Retrieves whether the timeout option was set.

uint_fast64_t	getTimeoutInSeconds () const
	Retrieves the time after which the computation has to be aborted in case the timeout option was set.

uint_fast64_t	getSignalWaitingTimeInSeconds () const
	Retrieves the waiting time of the program after a signal.

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

virtual	~ModuleSettings ()

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

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

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 resource settings.

Definition at line 13 of file ResourceSettings.h.

Constructor & Destructor Documentation

◆ ResourceSettings()

storm::settings::modules::ResourceSettings::ResourceSettings ( )

Creates a new set of general settings.

Definition at line 20 of file ResourceSettings.cpp.

Member Function Documentation

◆ getSignalWaitingTimeInSeconds()

uint_fast64_t storm::settings::modules::ResourceSettings::getSignalWaitingTimeInSeconds ( ) const

Retrieves the waiting time of the program after a signal.

If a signal to abort is handled, the program should terminate. However, it waits the given number of seconds before it is killed to allow for printing preliminary results.

Returns: The number of seconds after which to exit the program.

Definition at line 52 of file ResourceSettings.cpp.

◆ getTimeoutInSeconds()

uint_fast64_t storm::settings::modules::ResourceSettings::getTimeoutInSeconds ( ) const

Retrieves the time after which the computation has to be aborted in case the timeout option was set.

Returns: The number of seconds after which to timeout.

Definition at line 44 of file ResourceSettings.cpp.

◆ isPrintTimeAndMemorySet()

bool storm::settings::modules::ResourceSettings::isPrintTimeAndMemorySet ( ) const

Retrieves whether time and memory consumption shall be printed at the end of a run.

Returns: True iff the option was set.

Definition at line 48 of file ResourceSettings.cpp.

◆ isTimeoutSet()

bool storm::settings::modules::ResourceSettings::isTimeoutSet ( ) const

Retrieves whether the timeout option was set.

Returns: True if the timeout option was set.

Definition at line 40 of file ResourceSettings.cpp.

Member Data Documentation

◆ moduleName

const std::string storm::settings::modules::ResourceSettings::moduleName = "resources"

static

Definition at line 51 of file ResourceSettings.h.

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members