src/gromacs/options/optionsection.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018,2019, 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::OptionSection and gmx::OptionSectionInfo.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_OPTIONSECTION_H
  44 #define GMX_OPTIONS_OPTIONSECTION_H
  45
  46 #include "gromacs/utility/classhelpers.h"
  47
  48 #include "abstractsection.h"
  49
  50 namespace gmx
  51 {
  52
  53 class OptionSectionHandle;
  54
  55 /*! \brief
  56  * Declares a simple option section.
  57  *
  58  * This class declares a simple section that only provides structure for
  59  * grouping the options, but does not otherwise influence the behavior of the
  60  * contained options.
  61  *
  62  * \inpublicapi
  63  * \ingroup module_options
  64  */
  65 class OptionSection : public AbstractOptionSection
  66 {
  67 public:
  68     //! AbstractOptionSectionHandle corresponding to this option type.
  69     typedef OptionSectionHandle HandleType;
  70
  71     //! Creates a section with the given name.
  72     explicit OptionSection(const char* name) : AbstractOptionSection(name) {}
  73
  74 private:
  75     std::unique_ptr<IOptionSectionStorage> createStorage() const override;
  76 };
  77
  78 /*! \brief
  79  * Allows adding options to an OptionSection.
  80  *
  81  * An instance of this class is returned from
  82  * IOptionsContainerWithSections::addSection(), and supports adding options and
  83  * subsections to a section created with OptionSection.
  84  *
  85  * \inpublicapi
  86  * \ingroup module_options
  87  */
  88 class OptionSectionHandle : public AbstractOptionSectionHandle
  89 {
  90 public:
  91     //! Wraps a given section storage object.
  92     explicit OptionSectionHandle(internal::OptionSectionImpl* section) :
  93         AbstractOptionSectionHandle(section)
  94     {
  95     }
  96 };
  97
  98 class OptionSectionInfo : public AbstractOptionSectionInfo
  99 {
 100 public:
 101     //! Wraps a given section storage object.
 102     explicit OptionSectionInfo(internal::OptionSectionImpl* section) :
 103         AbstractOptionSectionInfo(section)
 104     {
 105     }
 106 };
 107
 108 } // namespace gmx
 109
 110 #endif