storm::settings::ArgumentBuilder Class Reference

This class serves as an API for creating arguments. More...

#include <ArgumentBuilder.h>

Public Member Functions
ArgumentBuilder &	makeOptional ()
	Make the argument optional.
	MACROaddValidator (String, std::string) MACROaddValidator(Integer
int_fast64_t	MACROaddValidator (UnsignedInteger, uint_fast64_t) MACROaddValidator(Double
int_fast64_t double	MACROaddValidator (Boolean, bool) MACROsetDefaultValue(String
int_fast64_t double std::string	MACROsetDefaultValue (Integer, int_fast64_t) MACROsetDefaultValue(UnsignedInteger
int_fast64_t double std::string uint_fast64_t	MACROsetDefaultValue (Double, double) MACROsetDefaultValue(Boolean
int_fast64_t double std::string uint_fast64_t bool std::shared_ptr< ArgumentBase >	build ()
	Builds an argument based on the information that was added to the builder object.

Static Public Member Functions
static ArgumentBuilder	createStringArgument (std::string const &name, std::string const &description)
	Creates a string argument with the given parameters.
static ArgumentBuilder	createIntegerArgument (std::string const &name, std::string const &description)
	Creates an integer argument with the given parameters.
static ArgumentBuilder	createUnsignedIntegerArgument (std::string const &name, std::string const &description)
	Creates an unsigned integer argument with the given parameters.
static ArgumentBuilder	createDoubleArgument (std::string const &name, std::string const &description)
	Creates a double argument with the given parameters.
static ArgumentBuilder	createBooleanArgument (std::string const &name, std::string const &description)
	Creates a boolean argument with the given parameters.

Detailed Description

This class serves as an API for creating arguments.

Definition at line 29 of file ArgumentBuilder.h.

Member Function Documentation

build()

int_fast64_t double std::string uint_fast64_t bool std::shared_ptr< ArgumentBase > storm::settings::ArgumentBuilder::build ( )

inline

Builds an argument based on the information that was added to the builder object.

Returns

The resulting argument.

Definition at line 134 of file ArgumentBuilder.h.

createBooleanArgument()

static ArgumentBuilder storm::settings::ArgumentBuilder::createBooleanArgument ( std::string const &  name, std::string const &  description  )

inlinestatic

Creates a boolean argument with the given parameters.

Parameters

name	The name of the argument.
description	The description of the argument.

Returns

The builder of the argument.

Definition at line 86 of file ArgumentBuilder.h.

createDoubleArgument()

static ArgumentBuilder storm::settings::ArgumentBuilder::createDoubleArgument ( std::string const &  name, std::string const &  description  )

inlinestatic

Creates a double argument with the given parameters.

Parameters

name	The name of the argument.
description	The description of the argument.

Returns

The builder of the argument.

Definition at line 74 of file ArgumentBuilder.h.

createIntegerArgument()

static ArgumentBuilder storm::settings::ArgumentBuilder::createIntegerArgument ( std::string const &  name, std::string const &  description  )

inlinestatic

Creates an integer argument with the given parameters.

Parameters

name	The name of the argument.
description	The description of the argument.

Returns

The builder of the argument.

Definition at line 50 of file ArgumentBuilder.h.

createStringArgument()

static ArgumentBuilder storm::settings::ArgumentBuilder::createStringArgument ( std::string const &  name, std::string const &  description  )

inlinestatic

Creates a string argument with the given parameters.

Parameters

name	The name of the argument.
description	The description of the argument.

Returns

The builder of the argument.

Definition at line 38 of file ArgumentBuilder.h.

createUnsignedIntegerArgument()

static ArgumentBuilder storm::settings::ArgumentBuilder::createUnsignedIntegerArgument ( std::string const &  name, std::string const &  description  )

inlinestatic

Creates an unsigned integer argument with the given parameters.

Parameters

name	The name of the argument.
description	The description of the argument.

Returns

The builder of the argument.

Definition at line 62 of file ArgumentBuilder.h.

MACROaddValidator() [1/3]

int_fast64_t double storm::settings::ArgumentBuilder::MACROaddValidator	(	Boolean	,
		bool
	)

MACROaddValidator() [2/3]

storm::settings::ArgumentBuilder::MACROaddValidator	(	String	,
		std::string
	)

MACROaddValidator() [3/3]

int_fast64_t storm::settings::ArgumentBuilder::MACROaddValidator	(	UnsignedInteger	,
		uint_fast64_t
	)

MACROsetDefaultValue() [1/2]

int_fast64_t double std::string uint_fast64_t storm::settings::ArgumentBuilder::MACROsetDefaultValue	(	Double	,
		double
	)

MACROsetDefaultValue() [2/2]

int_fast64_t double std::string storm::settings::ArgumentBuilder::MACROsetDefaultValue	(	Integer	,
		int_fast64_t
	)

makeOptional()

ArgumentBuilder & storm::settings::ArgumentBuilder::makeOptional ( )

inline

Make the argument optional.

Returns

A reference to the argument builder.

Definition at line 96 of file ArgumentBuilder.h.

---

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

• src/storm/settings/ArgumentBuilder.h