storm::settings::OptionBuilder Class Reference

This class provides the interface to create an option... More...

#include <OptionBuilder.h>

Public Member Functions
	OptionBuilder (std::string const &moduleName, std::string const &longName, bool requireModulePrefix, std::string const &description)
	Creates a new option builder for an option with the given module, name and description.
OptionBuilder &	setShortName (std::string const &shortName)
	Sets a short name for the option.
OptionBuilder &	setIsRequired (bool isRequired)
	Sets whether the option is required.
OptionBuilder &	setIsAdvanced (bool isAdvanced=true)
	Sets whether the option is only displayed in the advanced help.
OptionBuilder &	addArgument (std::shared_ptr< ArgumentBase > argument)
	Adds the given argument to the arguments of this option.
std::shared_ptr< Option >	build ()
	Builds an option from the data that was added to this builder.

Detailed Description

This class provides the interface to create an option...

Definition at line 26 of file OptionBuilder.h.

Constructor & Destructor Documentation

OptionBuilder()

storm::settings::OptionBuilder::OptionBuilder ( std::string const &  moduleName, std::string const &  longName, bool  requireModulePrefix, std::string const &  description  )

inline

Creates a new option builder for an option with the given module, name and description.

Parameters

moduleName	The name of the module to which this option belongs.
longName	The long name of the option.
requireModulePrefix	Sets whether this option can only be set by specifying the module name as its prefix.
description	A description that explains the purpose of this option.

Definition at line 36 of file OptionBuilder.h.

Member Function Documentation

addArgument()

OptionBuilder & storm::settings::OptionBuilder::addArgument ( std::shared_ptr< ArgumentBase >  argument )

inline

Adds the given argument to the arguments of this option.

Parameters

argument

The argument to be added.

Returns

A reference to the current builder.

Definition at line 88 of file OptionBuilder.h.

build()

std::shared_ptr< Option > storm::settings::OptionBuilder::build ( )

inline

Builds an option from the data that was added to this builder.

Returns

The resulting option.

Definition at line 109 of file OptionBuilder.h.

setIsAdvanced()

OptionBuilder & storm::settings::OptionBuilder::setIsAdvanced ( bool  isAdvanced = true )

inline

Sets whether the option is only displayed in the advanced help.

Definition at line 77 of file OptionBuilder.h.

setIsRequired()

OptionBuilder & storm::settings::OptionBuilder::setIsRequired ( bool  isRequired )

inline

Sets whether the option is required.

Parameters

isRequired

A flag indicating whether the option is required.

Returns

A reference to the current builder.

Definition at line 69 of file OptionBuilder.h.

setShortName()

OptionBuilder & storm::settings::OptionBuilder::setShortName ( std::string const &  shortName )

inline

Sets a short name for the option.

Parameters

shortName

A short name for the option.

Returns

A reference to the current builder.

Definition at line 57 of file OptionBuilder.h.

---

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

• src/storm/settings/OptionBuilder.h