Gromacs  2024.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
gmx::OptionSectionHandle Class Reference

#include <gromacs/options/optionsection.h>

+ Inheritance diagram for gmx::OptionSectionHandle:
+ Collaboration diagram for gmx::OptionSectionHandle:


Allows adding options to an OptionSection.

An instance of this class is returned from IOptionsContainerWithSections::addSection(), and supports adding options and subsections to a section created with OptionSection.

Public Member Functions

 OptionSectionHandle (internal::OptionSectionImpl *section)
 Wraps a given section storage object.
IOptionsContaineraddGroup () override
 Creates a subgroup of options within the current options. More...
template<class SectionType >
SectionType::HandleType addSection (const SectionType &section)
 Adds a section to this collection. More...
template<class OptionType >
OptionType::InfoType * addOption (const OptionType &settings)
 Adds a recognized option. More...

Protected Member Functions

 GMX_DEFAULT_CONSTRUCTORS (IOptionsContainerWithSections)

Member Function Documentation

IOptionsContainer & gmx::AbstractOptionSectionHandle::addGroup ( )

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.

Implements gmx::IOptionsContainer.

template<class OptionType >
OptionType::InfoType* gmx::IOptionsContainer::addOption ( const OptionType &  settings)

Adds a recognized option.

Template Parameters
OptionTypeType of the options description object.
[in]settingsOption description.
OptionInfo object for the created option (never NULL).
APIErrorif 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.

template<class SectionType >
SectionType::HandleType gmx::IOptionsContainerWithSections::addSection ( const SectionType &  section)

Adds a section to this collection.

Template Parameters
SectionTypeType of the section description object.
[in]sectionSection description.
AbstractOptionSectionHandle object for the created option.
APIErrorif invalid option settings are provided.

Options can be added to the section through the returned handle.

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