gmx::IOptionsContainer Class Reference

#include <gromacs/options/ioptionscontainer.h>

Inheritance diagram for gmx::IOptionsContainer:

Description

Interface for adding input options.

This interface provides methods to add new options. Standard usage is for code to receive this interface and populate it with supported options:

// <as class attributes>
std::string  arg1;
int          arg2;

void MyClass::initOptions(gmx::IOptionsContainer *options)
{
    options->addOption(gmx::StringOption("arg1").store(&arg1));
    options->addOption(gmx::IntegerOption("arg2").store(&arg2));
}

The caller can collect options from multiple sources into a single container (a gmx::Options), and use a parser implementation such as CommandLineParser to provide values for the options.

Header basicoptions.h provides declarations of several standard option types for use with addOption(). Documentation of those classes also give more examples of how to define options.

Examples:

template.cpp.

Public Member Functions
virtual IOptionsContainer &	addGroup ()=0
	Creates a subgroup of options within the current options. More...
virtual OptionInfo *	addOption (const AbstractOption &settings)=0
	Adds a recognized option. More...
template<class OptionType >
OptionType::InfoType *	addOption (const OptionType &settings)
	Adds a recognized option. More...

Member Function Documentation

virtual IOptionsContainer& gmx::IOptionsContainer::addGroup ( )

pure virtual

Creates a subgroup of options within the current options.

To add options to the group, use the returned interface.

Currently, this is only used to influence the order of options: all options in a group appear before options in a group added after it, no matter in which order the options are added to the groups. In the future, the groups could also be used to influence the help output.

Implemented in gmx::Options.

virtual OptionInfo* gmx::IOptionsContainer::addOption ( const AbstractOption &  settings )

pure virtual

Adds a recognized option.

Parameters

[in]

settings

Option description.

Returns

OptionInfo object for the created option (never NULL).

Exceptions

APIError

if invalid option settings are provided.

This method provides the internal implementation, but in most cases the templated method is called from user code. See the templated method for more details.

Implemented in gmx::Options.

Examples:

template.cpp.

template<class OptionType >

OptionType::InfoType* gmx::IOptionsContainer::addOption ( const OptionType &  settings )

inline

Adds a recognized option.

Template Parameters

OptionType

Type of the options description object.

Parameters

[in]

settings

Option description.

Returns

OptionInfo object for the created option (never NULL).

Exceptions

APIError

if invalid option settings are provided.

The return value is a pointer for more convenient use in callers: often callers need to declare the variable that will hold the return value in wider scope than would be achieved by declaring it at the site where addOption() is called. The returned pointer must not be freed.

See class documentation for example usage.

---

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

• src/gromacs/options/ioptionscontainer.h
• src/gromacs/options/options.cpp