#include <gromacs/options/ioptionscontainerwithsections.h>
Interface for adding input options with sections.
This interface extends IOptionsContainer with an additional addSection() method that supports creating a hierarchy of sections for the options.
Header optionsection.h provides OptionSection.
|
| template<class SectionType > |
| SectionType::HandleType | addSection (const SectionType §ion) |
| | Adds a section to this collection. More...
|
| |
| virtual IOptionsContainer & | addGroup ()=0 |
| | Creates a subgroup of options within the current options. More...
|
| |
| template<class OptionType > |
| OptionType::InfoType * | addOption (const OptionType &settings) |
| | Adds a recognized option. More...
|
| |
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, and gmx::AbstractOptionSectionHandle.
template<class OptionType >
| OptionType::InfoType* gmx::IOptionsContainer::addOption |
( |
const OptionType & |
settings | ) |
|
|
inlineinherited |
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.
OptionType::InfoType must specify a type that derives from OptionInfo and matches the type that is returned by AbstractOptionStorage::optionInfo() for the storage object that corresponds to OptionType.
- Examples:
- template.cpp.
|
|
protectedpure virtualinherited |
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 the templated method is called from user code. See the templated method for more details.
template<class SectionType >
| SectionType::HandleType gmx::IOptionsContainerWithSections::addSection |
( |
const SectionType & |
section | ) |
|
|
inline |
Adds a section to this collection.
- Template Parameters
-
| SectionType | Type of the section description object. |
- Parameters
-
| [in] | section | Section description. |
- Returns
- AbstractOptionSectionHandle object for the created option.
- Exceptions
-
| APIError | if invalid option settings are provided. |
Options can be added to the section through the returned handle.
| virtual internal::OptionSectionImpl* gmx::IOptionsContainerWithSections::addSectionImpl |
( |
const AbstractOptionSection & |
section | ) |
|
|
protectedpure virtual |
Adds a section to this container.
- Parameters
-
| [in] | section | Section description. |
- Returns
- Pointer to the internal section representation object.
The documentation for this class was generated from the following files:
Inheritance diagram for gmx::IOptionsContainerWithSections:
1.8.5