src/gromacs/options/options-impl.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Declares private implementation class for gmx::Options.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_options
  37  */
  38 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
  39 #define GMX_OPTIONS_OPTIONS_IMPL_H
  40
  41 #include <string>
  42 #include <vector>
  43
  44 #include "abstractoption.h"
  45 #include "options.h"
  46
  47 namespace gmx
  48 {
  49
  50 class AbstractOptionStorage;
  51
  52 /*! \internal \brief
  53  * Private implementation class for Options.
  54  *
  55  * Note that in addition to Options, the OptionsAssigner and OptionsIterator
  56  * classes also directly access this class.
  57  *
  58  * \ingroup module_options
  59  */
  60 class Options::Impl
  61 {
  62     public:
  63         //! Convenience type for list of sections.
  64         typedef std::vector<Options *> SubSectionList;
  65         //! Convenience type for list of options.
  66         typedef std::vector<AbstractOptionStoragePointer> OptionList;
  67
  68         //! Sets the name and title.
  69         Impl(const char *name, const char *title);
  70         ~Impl();
  71
  72         /*! \brief
  73          * Finds a subsection by name.
  74          *
  75          * \param[in] name  Name to search for.
  76          * \returns Pointer to the found subsection, or NULL if not found.
  77          *
  78          * Does not throw.
  79          */
  80         Options *findSubSection(const char *name) const;
  81         /*! \brief
  82          * Finds an option by name.
  83          *
  84          * \param[in] name  Name to search for.
  85          * \returns Pointer to the found option, or NULL if not found.
  86          *
  87          * Does not throw.
  88          */
  89         AbstractOptionStorage *findOption(const char *name) const;
  90
  91         /*! \brief
  92          * Calls AbstractOptionStorage::startSource() for all options,
  93          * including subsections.
  94          *
  95          * Does not throw.
  96          */
  97         void startSource();
  98
  99         //! Name for the Options object.
 100         std::string             _name;
 101         //! Description title for the Options object.
 102         std::string             _title;
 103         //! Full description for the Options object.
 104         std::string             _description;
 105         /*! \brief
 106          * List of subsections, in insertion order.
 107          *
 108          * This container contains only references to external objects; memory
 109          * management is performed elsewhere.
 110          */
 111         SubSectionList          _subSections;
 112         /*! \brief
 113          * List of options, in insertion order.
 114          *
 115          * All objects in this container are owned by this object, and are
 116          * freed in the destructor.
 117          */
 118         OptionList              _options;
 119         //! Options object that contains this object as a subsection, or NULL.
 120         Options                *_parent;
 121 };
 122
 123 } // namespace gmx
 124
 125 #endif