gmx::IOptionsContainerWithSections Class Reference

#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 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...

Protected Member Functions
virtual internal::OptionSectionImpl *	addSectionImpl (const AbstractOptionSection &section)=0
	Adds a section to this container. More...
	GMX_DEFAULT_CONSTRUCTORS (IOptionsContainerWithSections)
Protected Member Functions inherited from gmx::IOptionsContainer
virtual OptionInfo *	addOptionImpl (const AbstractOption &settings)=0
	Adds a recognized option. More...
	GMX_DEFAULT_CONSTRUCTORS (IOptionsContainer)

Member Function Documentation

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.

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]

section

Section 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:

• api/legacy/include/gromacs/options/ioptionscontainerwithsections.h
• src/gromacs/options/options.cpp