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

#include <gromacs/options/ioptionscontainerwithsections.h>

+ Inheritance diagram for gmx::IOptionsContainerWithSections:
+ Collaboration diagram for gmx::IOptionsContainerWithSections:

Description

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.

Public Member Functions

template<class SectionType >
SectionType::HandleType addSection (const SectionType &section)
 Adds a section to this collection. More...
 
virtual IOptionsContaineraddGroup ()=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...
 

Protected Member Functions

virtual
internal::OptionSectionImpl * 
addSectionImpl (const AbstractOptionSection &section)=0
 Adds a section to this container. More...
 
virtual OptionInfoaddOptionImpl (const AbstractOption &settings)=0
 Adds a recognized option. More...
 

Member Function Documentation

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

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

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.
virtual OptionInfo* gmx::IOptionsContainer::addOptionImpl ( const AbstractOption settings)
protectedpure virtualinherited

Adds a recognized option.

Parameters
[in]settingsOption description.
Returns
OptionInfo object for the created option (never NULL).
Exceptions
APIErrorif 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
SectionTypeType of the section description object.
Parameters
[in]sectionSection description.
Returns
AbstractOptionSectionHandle object for the created option.
Exceptions
APIErrorif 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]sectionSection description.
Returns
Pointer to the internal section representation object.

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