basicoptions.h File Reference

#include <memory>
#include <string>
#include <vector>
#include "gromacs/options/abstractoption.h"
#include "gromacs/utility/arrayref.h"
#include "gromacs/utility/basedefinitions.h"
#include "gromacs/utility/gmxassert.h"
#include "ivaluestore.h"

Include dependency graph for basicoptions.h:

This graph shows which files directly or indirectly include this file:

Description

Declares option objects for basic option types.

Together with options.h, this header forms the part of the public API that most classes will use to provide options.

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::BooleanOption
	Specifies an option that provides boolean values. More...
class	gmx::IntegerOption
	Specifies an option that provides integer values. More...
class	gmx::Int64Option
	Specifies an option that provides 64-bit integer values. More...
class	gmx::DoubleOption
	Specifies an option that provides floating-point (double) values. More...
class	gmx::FloatOption
	Specifies an option that provides floating-point (float) values. More...
class	gmx::StringOption
	Specifies an option that provides string values. More...
class	gmx::internal::EnumIndexStore< EnumType >
	Type-specific implementation for IOptionValueStore for an enum option. More...
class	gmx::EnumOption< EnumType >
	Specifies an option that accepts enumerated string values and writes the selected index into an enum variable. More...
class	gmx::BooleanOptionInfo
	Wrapper class for accessing boolean option information. More...
class	gmx::IntegerOptionInfo
	Wrapper class for accessing integer option information. More...
class	gmx::Int64OptionInfo
	Wrapper class for accessing 64-bit integer option information. More...
class	gmx::DoubleOptionInfo
	Wrapper class for accessing floating-point option information. More...
class	gmx::FloatOptionInfo
	Wrapper class for accessing floating-point option information. More...
class	gmx::StringOptionInfo
	Wrapper class for accessing string option information. More...
class	gmx::EnumOptionInfo
	Wrapper class for accessing enum option information. More...

Typedefs
typedef EnumOption< int >	gmx::EnumIntOption
	Shorthand for an enumerated option that stores into an int variable.
typedef FloatOption	gmx::RealOption
	Typedef for either DoubleOption or FloatOption, depending on precision. More...
typedef FloatOptionInfo	gmx::RealOptionInfo
	Typedef for either DoubleOptionInfo or FloatOptionInfo, depending on precision. More...

Functions
AbstractOptionStorage *	gmx::internal::createEnumOptionStorage (const AbstractOption &option, const char *const *enumValues, int count, int defaultValue, int defaultValueIfSet, std::unique_ptr< IOptionValueStore< int >> store)
	Helper to create EnumOptionStorage instances. More...