src/gromacs/options/options-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013, 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 /*! \internal \file
  36  * \brief
  37  * Declares private implementation class for gmx::Options.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
  43 #define GMX_OPTIONS_OPTIONS_IMPL_H
  44
  45 #include <string>
  46 #include <vector>
  47
  48 #include "abstractoption.h"
  49 #include "options.h"
  50
  51 namespace gmx
  52 {
  53
  54 class AbstractOptionStorage;
  55
  56 /*! \internal
  57  * \brief
  58  * Private implementation class for Options.
  59  *
  60  * Note that in addition to Options, the OptionsAssigner and OptionsIterator
  61  * classes also directly access this class.
  62  *
  63  * \ingroup module_options
  64  */
  65 class Options::Impl
  66 {
  67     public:
  68         //! Convenience type for list of sections.
  69         typedef std::vector<Options *> SubSectionList;
  70         //! Convenience type for list of options.
  71         typedef std::vector<AbstractOptionStoragePointer> OptionList;
  72
  73         //! Sets the name and title.
  74         Impl(const char *name, const char *title);
  75         ~Impl();
  76
  77         /*! \brief
  78          * Finds a subsection by name.
  79          *
  80          * \param[in] name  Name to search for.
  81          * \returns Pointer to the found subsection, or NULL if not found.
  82          *
  83          * Does not throw.
  84          */
  85         Options *findSubSection(const char *name) const;
  86         /*! \brief
  87          * Finds an option by name.
  88          *
  89          * \param[in] name  Name to search for.
  90          * \returns Pointer to the found option, or NULL if not found.
  91          *
  92          * Does not throw.
  93          */
  94         AbstractOptionStorage *findOption(const char *name) const;
  95
  96         /*! \brief
  97          * Calls AbstractOptionStorage::startSource() for all options,
  98          * including subsections.
  99          *
 100          * Does not throw.
 101          */
 102         void startSource();
 103
 104         //! Name for the Options object.
 105         std::string             name_;
 106         //! Description title for the Options object.
 107         std::string             title_;
 108         //! Full description for the Options object.
 109         std::string             description_;
 110         /*! \brief
 111          * List of subsections, in insertion order.
 112          *
 113          * This container contains only references to external objects; memory
 114          * management is performed elsewhere.
 115          */
 116         SubSectionList          subSections_;
 117         /*! \brief
 118          * List of options, in insertion order.
 119          *
 120          * All objects in this container are owned by this object, and are
 121          * freed in the destructor.
 122          */
 123         OptionList              options_;
 124         //! Options object that contains this object as a subsection, or NULL.
 125         Options                *parent_;
 126 };
 127
 128 } // namespace gmx
 129
 130 #endif