src/gromacs/options/ioptionscontainerwithsections.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares gmx::IOptionsContainerWithSections.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_IOPTIONSCONTAINERWITHSECTIONS_H
  44 #define GMX_OPTIONS_IOPTIONSCONTAINERWITHSECTIONS_H
  45
  46 #include "gromacs/options/ioptionscontainer.h"
  47
  48 namespace gmx
  49 {
  50
  51 class AbstractOptionSection;
  52 class AbstractOptionSectionHandle;
  53
  54 namespace internal
  55 {
  56 class OptionSectionImpl;
  57 }
  58
  59 /*! \brief
  60  * Interface for adding input options with sections.
  61  *
  62  * This interface extends IOptionsContainer with an additional addSection()
  63  * method that supports creating a hierarchy of sections for the options.
  64  *
  65  * Header optionsection.h provides OptionSection.
  66  *
  67  * \inpublicapi
  68  * \ingroup module_options
  69  */
  70 class IOptionsContainerWithSections : public IOptionsContainer
  71 {
  72     public:
  73         /*! \brief
  74          * Adds a section to this collection.
  75          *
  76          * \tparam    SectionType Type of the section description object.
  77          * \param[in] section     Section description.
  78          * \returns   AbstractOptionSectionHandle object for the created option.
  79          * \throws    APIError if invalid option settings are provided.
  80          *
  81          * Options can be added to the section through the returned handle.
  82          *
  83          * \internal
  84          * \p SectionType::HandleType must specify a type that derives from
  85          * AbstractinOptionSectionHandle and has a suitable constructor.
  86          */
  87         template <class SectionType>
  88         typename SectionType::HandleType addSection(const SectionType &section)
  89         {
  90             internal::OptionSectionImpl *storage
  91                 = addSectionImpl(static_cast<const AbstractOptionSection &>(section));
  92             return typename SectionType::HandleType(storage);
  93         }
  94
  95     protected:
  96         // Disallow deletion through the interface.
  97         // (no need for the virtual, but some compilers warn otherwise)
  98         virtual ~IOptionsContainerWithSections();
  99
 100         /*! \brief
 101          * Adds a section to this container.
 102          *
 103          * \param[in] section     Section description.
 104          * \returns   Pointer to the internal section representation object.
 105          */
 106         virtual internal::OptionSectionImpl *
 107         addSectionImpl(const AbstractOptionSection &section) = 0;
 108
 109         GMX_DEFAULT_CONSTRUCTORS(IOptionsContainerWithSections);
 110 };
 111
 112 }  // namespace gmx
 113
 114 #endif