storm::settings Namespace Reference

Namespaces
namespace	modules

Classes
class	Argument
	This class subclasses the argument base to actually implement the pure virtual functions. More...
class	ArgumentBase
	This class serves as the (untemplated) base class of argument classes. More...
class	ArgumentBuilder
	This class serves as an API for creating arguments. More...
class	ArgumentValidator
class	ArgumentValidatorFactory
class	FileValidator
class	MultipleChoiceValidator
class	Option
	This class represents one command-line option. More...
class	OptionBuilder
	This class provides the interface to create an option... More...
class	RangeArgumentValidator
class	SettingMemento
	This class is used to reset the state of an option that was temporarily set to a different status. More...
class	SettingsManager
	Provides the central API for the registration of command line options and parsing the options from the command line. More...

Enumerations
enum class	ArgumentType {   String , Integer , UnsignedInteger , Double ,   Boolean }
	This enum captures all possible types for arguments. More...

Functions
void	initializeConvSettings (std::string const &name, std::string const &executableName)
void	initializeParsSettings (std::string const &name, std::string const &executableName)
void	initializePomdpSettings (std::string const &name, std::string const &executableName)
	Initialize the settings manager.
template<typename T >
void	printValue (std::ostream &out, T const &value)
template<>
void	printValue (std::ostream &out, std::string const &value)
std::ostream &	operator<< (std::ostream &out, ArgumentBase const &argument)
std::ostream &	operator<< (std::ostream &out, ArgumentType &argumentType)
template<typename T >
ArgumentType	inferToEnumType ()
	This function infers the type in our enum of possible types from the template parameter.
template<>
ArgumentType	inferToEnumType< std::string > ()
template<>
ArgumentType	inferToEnumType< int_fast64_t > ()
template<>
ArgumentType	inferToEnumType< uint_fast64_t > ()
template<>
ArgumentType	inferToEnumType< double > ()
template<>
ArgumentType	inferToEnumType< bool > ()
template<typename T >
std::string const &	inferToString (ArgumentType const &, T const &)
template<>
std::string const &	inferToString< std::string > (ArgumentType const &argumentType, std::string const &value)
template<typename T >
int_fast64_t	inferToInteger (ArgumentType const &, T const &)
template<>
int_fast64_t	inferToInteger< int_fast64_t > (ArgumentType const &argumentType, int_fast64_t const &value)
template<typename T >
uint_fast64_t	inferToUnsignedInteger (ArgumentType const &, T const &)
template<>
uint_fast64_t	inferToUnsignedInteger< uint_fast64_t > (ArgumentType const &argumentType, uint_fast64_t const &value)
template<typename T >
double	inferToDouble (ArgumentType const &, T const &)
template<>
double	inferToDouble< double > (ArgumentType const &argumentType, double const &value)
template<typename T >
bool	inferToBoolean (ArgumentType const &, T const &)
template<>
bool	inferToBoolean< bool > (ArgumentType const &argumentType, bool const &value)
template std::string const &	inferToString< int_fast64_t > (ArgumentType const &argumentType, int_fast64_t const &value)
template std::string const &	inferToString< uint_fast64_t > (ArgumentType const &argumentType, uint_fast64_t const &value)
template std::string const &	inferToString< double > (ArgumentType const &argumentType, double const &value)
template std::string const &	inferToString< bool > (ArgumentType const &argumentType, bool const &value)
template int_fast64_t	inferToInteger< std::string > (ArgumentType const &argumentType, std::string const &value)
template int_fast64_t	inferToInteger< uint_fast64_t > (ArgumentType const &argumentType, uint_fast64_t const &value)
template int_fast64_t	inferToInteger< double > (ArgumentType const &argumentType, double const &value)
template int_fast64_t	inferToInteger< bool > (ArgumentType const &argumentType, bool const &value)
template uint_fast64_t	inferToUnsignedInteger< std::string > (ArgumentType const &argumentType, std::string const &value)
template uint_fast64_t	inferToUnsignedInteger< int_fast64_t > (ArgumentType const &argumentType, int_fast64_t const &value)
template uint_fast64_t	inferToUnsignedInteger< double > (ArgumentType const &argumentType, double const &value)
template uint_fast64_t	inferToUnsignedInteger< bool > (ArgumentType const &argumentType, bool const &value)
template double	inferToDouble< std::string > (ArgumentType const &argumentType, std::string const &value)
template double	inferToDouble< int_fast64_t > (ArgumentType const &argumentType, int_fast64_t const &value)
template double	inferToDouble< uint_fast64_t > (ArgumentType const &argumentType, uint_fast64_t const &value)
template double	inferToDouble< bool > (ArgumentType const &argumentType, bool const &value)
template bool	inferToBoolean< std::string > (ArgumentType const &argumentType, std::string const &value)
template bool	inferToBoolean< int_fast64_t > (ArgumentType const &argumentType, int_fast64_t const &value)
template bool	inferToBoolean< uint_fast64_t > (ArgumentType const &argumentType, uint_fast64_t const &value)
template bool	inferToBoolean< double > (ArgumentType const &argumentType, double const &value)
template<>
std::string const &	inferToString (ArgumentType const &argumentType, std::string const &value)
template<>
int_fast64_t	inferToInteger (ArgumentType const &argumentType, int_fast64_t const &value)
template<>
uint_fast64_t	inferToUnsignedInteger (ArgumentType const &argumentType, uint_fast64_t const &value)
template<>
double	inferToDouble (ArgumentType const &argumentType, double const &value)
template<>
bool	inferToBoolean (ArgumentType const &argumentType, bool const &value)
std::ostream &	operator<< (std::ostream &out, Option const &option)
SettingsManager const &	manager ()
	Retrieves the settings manager.
SettingsManager &	mutableManager ()
	Retrieves the settings manager.
storm::settings::modules::BuildSettings &	mutableBuildSettings ()
	Retrieves the build settings in a mutable form.
storm::settings::modules::AbstractionSettings &	mutableAbstractionSettings ()
	Retrieves the abstraction settings in a mutable form.
void	initializeAll (std::string const &name, std::string const &executableName)
	Initialize the settings manager with all available modules.
template<typename SettingsType >
void	addModule (bool doRegister=true)
	Add new module to use for the settings.
template<typename SettingsType >
SettingsType const &	getModule ()
	Get module.
template<typename SettingsType >
bool	hasModule ()
	Returns true if the given module is registered.

Enumeration Type Documentation

ArgumentType

enum class storm::settings::ArgumentType

strong

This enum captures all possible types for arguments.

Enumerator
String
Integer
UnsignedInteger
Double
Boolean

Definition at line 12 of file ArgumentType.h.

Function Documentation

addModule()

template<typename SettingsType >

void storm::settings::addModule

(

bool

doRegister = true

)

Add new module to use for the settings.

The new module is given as a template argument.

Definition at line 272 of file SettingsManager.h.

getModule()

template<typename SettingsType >

SettingsType const & storm::settings::getModule

(

)

Get module.

The type of the module is given as a template argument.

Returns

The module.

Definition at line 290 of file SettingsManager.h.

hasModule()

template<typename SettingsType >

bool storm::settings::hasModule

(

)

Returns true if the given module is registered.

Definition at line 300 of file SettingsManager.h.

inferToBoolean() [1/2]

template<typename T >

bool storm::settings::inferToBoolean	(	ArgumentType const &	,
		T const &
	)

Definition at line 82 of file ArgumentTypeInferationHelper.cpp.

inferToBoolean() [2/2]

template<>

bool storm::settings::inferToBoolean	(	ArgumentType const &	argumentType,
		bool const &	value
	)

inferToBoolean< bool >()

template<>

bool storm::settings::inferToBoolean< bool >	(	ArgumentType const &	argumentType,
		bool const &	value
	)

Definition at line 87 of file ArgumentTypeInferationHelper.cpp.

inferToBoolean< double >()

template bool storm::settings::inferToBoolean< double >	(	ArgumentType const &	argumentType,
		double const &	value
	)

inferToBoolean< int_fast64_t >()

template bool storm::settings::inferToBoolean< int_fast64_t >	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

inferToBoolean< std::string >()

template bool storm::settings::inferToBoolean< std::string >	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

inferToBoolean< uint_fast64_t >()

template bool storm::settings::inferToBoolean< uint_fast64_t >	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

inferToDouble() [1/2]

template<typename T >

double storm::settings::inferToDouble	(	ArgumentType const &	,
		T const &
	)

Definition at line 71 of file ArgumentTypeInferationHelper.cpp.

inferToDouble() [2/2]

template<>

double storm::settings::inferToDouble	(	ArgumentType const &	argumentType,
		double const &	value
	)

inferToDouble< bool >()

template double storm::settings::inferToDouble< bool >	(	ArgumentType const &	argumentType,
		bool const &	value
	)

inferToDouble< double >()

template<>

double storm::settings::inferToDouble< double >	(	ArgumentType const &	argumentType,
		double const &	value
	)

Definition at line 76 of file ArgumentTypeInferationHelper.cpp.

inferToDouble< int_fast64_t >()

template double storm::settings::inferToDouble< int_fast64_t >	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

inferToDouble< std::string >()

template double storm::settings::inferToDouble< std::string >	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

inferToDouble< uint_fast64_t >()

template double storm::settings::inferToDouble< uint_fast64_t >	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

inferToEnumType()

template<typename T >

ArgumentType storm::settings::inferToEnumType

(

)

This function infers the type in our enum of possible types from the template parameter.

Returns

The argument type that has been inferred.

Definition at line 7 of file ArgumentTypeInferationHelper.cpp.

inferToEnumType< bool >()

template<>

ArgumentType storm::settings::inferToEnumType< bool >

(

)

Definition at line 32 of file ArgumentTypeInferationHelper.cpp.

inferToEnumType< double >()

template<>

ArgumentType storm::settings::inferToEnumType< double >

(

)

Definition at line 27 of file ArgumentTypeInferationHelper.cpp.

inferToEnumType< int_fast64_t >()

template<>

ArgumentType storm::settings::inferToEnumType< int_fast64_t >

(

)

Definition at line 17 of file ArgumentTypeInferationHelper.cpp.

inferToEnumType< std::string >()

template<>

ArgumentType storm::settings::inferToEnumType< std::string >

(

)

Definition at line 12 of file ArgumentTypeInferationHelper.cpp.

inferToEnumType< uint_fast64_t >()

template<>

ArgumentType storm::settings::inferToEnumType< uint_fast64_t >

(

)

Definition at line 22 of file ArgumentTypeInferationHelper.cpp.

inferToInteger() [1/2]

template<typename T >

int_fast64_t storm::settings::inferToInteger	(	ArgumentType const &	,
		T const &
	)

Definition at line 48 of file ArgumentTypeInferationHelper.cpp.

inferToInteger() [2/2]

template<>

int_fast64_t storm::settings::inferToInteger	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

inferToInteger< bool >()

template int_fast64_t storm::settings::inferToInteger< bool >	(	ArgumentType const &	argumentType,
		bool const &	value
	)

inferToInteger< double >()

template int_fast64_t storm::settings::inferToInteger< double >	(	ArgumentType const &	argumentType,
		double const &	value
	)

inferToInteger< int_fast64_t >()

template<>

int_fast64_t storm::settings::inferToInteger< int_fast64_t >	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

Definition at line 53 of file ArgumentTypeInferationHelper.cpp.

inferToInteger< std::string >()

template int_fast64_t storm::settings::inferToInteger< std::string >	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

inferToInteger< uint_fast64_t >()

template int_fast64_t storm::settings::inferToInteger< uint_fast64_t >	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

inferToString() [1/2]

template<typename T >

std::string const & storm::settings::inferToString	(	ArgumentType const &	,
		T const &
	)

Definition at line 37 of file ArgumentTypeInferationHelper.cpp.

inferToString() [2/2]

template<>

std::string const & storm::settings::inferToString	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

inferToString< bool >()

template std::string const & storm::settings::inferToString< bool >	(	ArgumentType const &	argumentType,
		bool const &	value
	)

inferToString< double >()

template std::string const & storm::settings::inferToString< double >	(	ArgumentType const &	argumentType,
		double const &	value
	)

inferToString< int_fast64_t >()

template std::string const & storm::settings::inferToString< int_fast64_t >	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

inferToString< std::string >()

template<>

std::string const & storm::settings::inferToString< std::string >	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

Definition at line 42 of file ArgumentTypeInferationHelper.cpp.

inferToString< uint_fast64_t >()

template std::string const & storm::settings::inferToString< uint_fast64_t >	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

inferToUnsignedInteger() [1/2]

template<typename T >

uint_fast64_t storm::settings::inferToUnsignedInteger	(	ArgumentType const &	,
		T const &
	)

Definition at line 59 of file ArgumentTypeInferationHelper.cpp.

inferToUnsignedInteger() [2/2]

template<>

uint_fast64_t storm::settings::inferToUnsignedInteger	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

inferToUnsignedInteger< bool >()

template uint_fast64_t storm::settings::inferToUnsignedInteger< bool >	(	ArgumentType const &	argumentType,
		bool const &	value
	)

inferToUnsignedInteger< double >()

template uint_fast64_t storm::settings::inferToUnsignedInteger< double >	(	ArgumentType const &	argumentType,
		double const &	value
	)

inferToUnsignedInteger< int_fast64_t >()

template uint_fast64_t storm::settings::inferToUnsignedInteger< int_fast64_t >	(	ArgumentType const &	argumentType,
		int_fast64_t const &	value
	)

inferToUnsignedInteger< std::string >()

template uint_fast64_t storm::settings::inferToUnsignedInteger< std::string >	(	ArgumentType const &	argumentType,
		std::string const &	value
	)

inferToUnsignedInteger< uint_fast64_t >()

template<>

uint_fast64_t storm::settings::inferToUnsignedInteger< uint_fast64_t >	(	ArgumentType const &	argumentType,
		uint_fast64_t const &	value
	)

Definition at line 64 of file ArgumentTypeInferationHelper.cpp.

initializeAll()

void storm::settings::initializeAll	(	std::string const &	name,
		std::string const &	executableName
	)

Initialize the settings manager with all available modules.

Parameters

name	Name of the tool.
executableName	Filename of the executable.

Definition at line 678 of file SettingsManager.cpp.

initializeConvSettings()

void storm::settings::initializeConvSettings	(	std::string const &	name,
		std::string const &	executableName
	)

Definition at line 13 of file ConvSettings.cpp.

initializeParsSettings()

void storm::settings::initializeParsSettings	(	std::string const &	name,
		std::string const &	executableName
	)

Definition at line 39 of file ParsSettings.cpp.

initializePomdpSettings()

void storm::settings::initializePomdpSettings	(	std::string const &	name,
		std::string const &	executableName
	)

Initialize the settings manager.

Definition at line 39 of file PomdpSettings.cpp.

manager()

SettingsManager const & storm::settings::manager

(

)

Retrieves the settings manager.

Returns

The only settings manager.

Definition at line 662 of file SettingsManager.cpp.

mutableAbstractionSettings()

storm::settings::modules::AbstractionSettings & storm::settings::mutableAbstractionSettings

(

)

Retrieves the abstraction settings in a mutable form.

This is only meant to be used for debug purposes or very rare cases where it is necessary.

Returns

An object that allows accessing and modifying the abstraction settings.

Definition at line 674 of file SettingsManager.cpp.

mutableBuildSettings()

storm::settings::modules::BuildSettings & storm::settings::mutableBuildSettings

(

)

Retrieves the build settings in a mutable form.

This is only meant to be used for debug purposes or very rare cases where it is necessary.

Returns

An object that allows accessing and modifying the build settings.

Definition at line 670 of file SettingsManager.cpp.

mutableManager()

SettingsManager & storm::settings::mutableManager

(

)

Retrieves the settings manager.

Returns

The only settings manager.

Definition at line 666 of file SettingsManager.cpp.

operator<<() [1/3]

std::ostream & storm::settings::operator<<	(	std::ostream &	out,
		ArgumentBase const &	argument
	)

Definition at line 9 of file ArgumentBase.cpp.

operator<<() [2/3]

std::ostream & storm::settings::operator<<	(	std::ostream &	out,
		ArgumentType &	argumentType
	)

Definition at line 5 of file ArgumentType.cpp.

operator<<() [3/3]

std::ostream & storm::settings::operator<<	(	std::ostream &	out,
		Option const &	option
	)

Definition at line 200 of file Option.cpp.

printValue() [1/2]

template<>

void storm::settings::printValue	(	std::ostream &	out,
		std::string const &	value
	)

Definition at line 188 of file Argument.cpp.

printValue() [2/2]

template<typename T >

void storm::settings::printValue	(	std::ostream &	out,
		T const &	value
	)

Definition at line 183 of file Argument.cpp.