storm::settings::modules::ModuleSettings Class Reference

This is the base class of the settings for a particular module. More...

#include <ModuleSettings.h>

Inherited by storm::dft::settings::modules::DftGspnSettings, storm::dft::settings::modules::DftIOSettings, storm::dft::settings::modules::FaultTreeSettings, storm::settings::modules::AbstractionSettings, storm::settings::modules::BeliefExplorationSettings, storm::settings::modules::BisimulationSettings, storm::settings::modules::BuildSettings, storm::settings::modules::ConditionalSettings, storm::settings::modules::ConversionGeneralSettings, storm::settings::modules::ConversionInputSettings, storm::settings::modules::ConversionOutputSettings, storm::settings::modules::CoreSettings, storm::settings::modules::CounterexampleGeneratorSettings, storm::settings::modules::CuddSettings, storm::settings::modules::DebugSettings, storm::settings::modules::DerivativeSettings, storm::settings::modules::EigenEquationSolverSettings, storm::settings::modules::EliminationSettings, storm::settings::modules::ExplorationSettings, storm::settings::modules::FeasibilitySettings, storm::settings::modules::GSPNExportSettings, storm::settings::modules::GSPNSettings, storm::settings::modules::GameSolverSettings, storm::settings::modules::GeneralSettings, storm::settings::modules::GlpkSettings, storm::settings::modules::GmmxxEquationSolverSettings, storm::settings::modules::GurobiSettings, storm::settings::modules::HintSettings, storm::settings::modules::IOSettings, storm::settings::modules::JaniExportSettings, storm::settings::modules::LongRunAverageSolverSettings, storm::settings::modules::MinMaxEquationSolverSettings, storm::settings::modules::ModelCheckerSettings, storm::settings::modules::MonotonicitySettings, storm::settings::modules::MultiObjectiveSettings, storm::settings::modules::MultiplierSettings, storm::settings::modules::NativeEquationSolverSettings, storm::settings::modules::OviSolverSettings, storm::settings::modules::POMDPSettings, storm::settings::modules::ParametricSettings, storm::settings::modules::PartitionSettings, storm::settings::modules::PrismExportSettings, storm::settings::modules::QualitativePOMDPAnalysisSettings, storm::settings::modules::RegionSettings, storm::settings::modules::RegionVerificationSettings, storm::settings::modules::ResourceSettings, storm::settings::modules::SamplingSettings, storm::settings::modules::SylvanSettings, storm::settings::modules::TimeBoundedSolverSettings, storm::settings::modules::TopologicalEquationSolverSettings, and storm::settings::modules::TransformationSettings.

Public Member Functions
	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::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.

Protected Member Functions
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	addOption (std::shared_ptr< Option > const &option)
	Adds and registers the given option.

Detailed Description

This is the base class of the settings for a particular module.

Definition at line 20 of file ModuleSettings.h.

Constructor & Destructor Documentation

ModuleSettings()

storm::settings::modules::ModuleSettings::ModuleSettings

(

std::string const &

moduleName

)

Constructs a new settings object.

Parameters

moduleName

The name of the module for which to build the settings.

Definition at line 11 of file ModuleSettings.cpp.

~ModuleSettings()

virtual storm::settings::modules::ModuleSettings::~ModuleSettings ( )

inlinevirtual

Definition at line 28 of file ModuleSettings.h.

Member Function Documentation

addOption()

void storm::settings::modules::ModuleSettings::addOption ( std::shared_ptr< Option > const & option )

protected

Adds and registers the given option.

Parameters

option

The option to add and register.

Definition at line 47 of file ModuleSettings.cpp.

check()

bool storm::settings::modules::ModuleSettings::check ( ) const

virtual

Checks whether the settings are consistent.

If they are inconsistent, an exception is thrown.

Returns

True if the settings are consistent.

Reimplemented in storm::dft::settings::modules::DftGspnSettings, storm::dft::settings::modules::DftIOSettings, storm::dft::settings::modules::FaultTreeSettings, storm::settings::modules::BisimulationSettings, storm::settings::modules::ConversionGeneralSettings, storm::settings::modules::ConversionInputSettings, storm::settings::modules::ConversionOutputSettings, storm::settings::modules::CoreSettings, storm::settings::modules::CounterexampleGeneratorSettings, storm::settings::modules::EigenEquationSolverSettings, storm::settings::modules::ExplorationSettings, storm::settings::modules::GeneralSettings, storm::settings::modules::GlpkSettings, storm::settings::modules::GmmxxEquationSolverSettings, storm::settings::modules::GSPNExportSettings, storm::settings::modules::GSPNSettings, storm::settings::modules::GurobiSettings, storm::settings::modules::HintSettings, storm::settings::modules::IOSettings, storm::settings::modules::JaniExportSettings, storm::settings::modules::MultiObjectiveSettings, storm::settings::modules::NativeEquationSolverSettings, storm::settings::modules::POMDPSettings, storm::settings::modules::PrismExportSettings, storm::settings::modules::QualitativePOMDPAnalysisSettings, storm::settings::modules::SylvanSettings, storm::settings::modules::TopologicalEquationSolverSettings, and storm::settings::modules::TransformationSettings.

Definition at line 15 of file ModuleSettings.cpp.

finalize()

void storm::settings::modules::ModuleSettings::finalize ( )

virtual

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

Reimplemented in storm::dft::settings::modules::DftGspnSettings, storm::dft::settings::modules::DftIOSettings, storm::dft::settings::modules::FaultTreeSettings, storm::settings::modules::ConversionGeneralSettings, storm::settings::modules::ConversionInputSettings, storm::settings::modules::ConversionOutputSettings, storm::settings::modules::CoreSettings, storm::settings::modules::GeneralSettings, storm::settings::modules::GSPNExportSettings, storm::settings::modules::GSPNSettings, storm::settings::modules::HintSettings, storm::settings::modules::IOSettings, storm::settings::modules::JaniExportSettings, storm::settings::modules::POMDPSettings, storm::settings::modules::PrismExportSettings, storm::settings::modules::QualitativePOMDPAnalysisSettings, and storm::settings::modules::TransformationSettings.

Definition at line 19 of file ModuleSettings.cpp.

getModuleName()

std::string const & storm::settings::modules::ModuleSettings::getModuleName

(

)

const

Retrieves the name of the module to which these settings belong.

Returns

The name of the module.

Definition at line 39 of file ModuleSettings.cpp.

getOption() [1/2]

Option & storm::settings::modules::ModuleSettings::getOption ( std::string const & longName )

protected

Retrieves the option with the given long name.

If no such option exists, an exception is thrown.

Parameters

longName

The long name of the option to retrieve.

Returns

The option associated with the given option name.

Definition at line 32 of file ModuleSettings.cpp.

getOption() [2/2]

Option const & storm::settings::modules::ModuleSettings::getOption ( std::string const & longName ) const

protected

Retrieves the option with the given long name.

If no such option exists, an exception is thrown.

Parameters

longName

The long name of the option to retrieve.

Returns

The option associated with the given option name.

Definition at line 25 of file ModuleSettings.cpp.

getOptions()

std::vector< std::shared_ptr< Option > > const & storm::settings::modules::ModuleSettings::getOptions

(

)

const

Retrieves the options of this module.

Returns

A list of options of this module.

Definition at line 21 of file ModuleSettings.cpp.

getPrintLengthOfLongestOption()

uint_fast64_t storm::settings::modules::ModuleSettings::getPrintLengthOfLongestOption

(

bool

includeAdvanced

)

const

Retrieves the (print) length of the longest option.

Parameters

includeAdvanced

if set, also includes options flagged as advanced.

Returns

The length of the longest option.

Definition at line 56 of file ModuleSettings.cpp.

isSet()

bool storm::settings::modules::ModuleSettings::isSet ( std::string const & optionName ) const

protected

Retrieves whether the option with the given name was set.

Parameters

The	name of the option.

Returns

True iff the option was set.

Definition at line 43 of file ModuleSettings.cpp.

restoreDefaults()

void storm::settings::modules::ModuleSettings::restoreDefaults

(

)

Restores the default values for all arguments of all options.

Definition at line 66 of file ModuleSettings.cpp.

---

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

• src/storm/settings/modules/ModuleSettings.h
• src/storm/settings/modules/ModuleSettings.cpp