Gromacs  2020.4
 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...
 
- Public Member Functions inherited from gmx::IOptionsContainer
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...
 
- Protected Member Functions inherited from gmx::IOptionsContainer
virtual OptionInfoaddOptionImpl (const AbstractOption &settings)=0
 Adds a recognized option. More...
 

Member Function Documentation

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.

SectionType::HandleType must specify a type that derives from AbstractinOptionSectionHandle and has a suitable constructor.

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.

Implemented in gmx::internal::OptionSectionImpl.


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