2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Declares private implementation class for gmx::Options.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
43 #define GMX_OPTIONS_OPTIONS_IMPL_H
48 #include "abstractoption.h"
54 class AbstractOptionStorage;
57 * Private implementation class for Options.
59 * Note that in addition to Options, the OptionsAssigner and OptionsIterator
60 * classes also directly access this class.
62 * \ingroup module_options
67 //! Convenience type for list of sections.
68 typedef std::vector<Options *> SubSectionList;
69 //! Convenience type for list of options.
70 typedef std::vector<AbstractOptionStoragePointer> OptionList;
72 //! Sets the name and title.
73 Impl(const char *name, const char *title);
77 * Finds a subsection by name.
79 * \param[in] name Name to search for.
80 * \returns Pointer to the found subsection, or NULL if not found.
84 Options *findSubSection(const char *name) const;
86 * Finds an option by name.
88 * \param[in] name Name to search for.
89 * \returns Pointer to the found option, or NULL if not found.
93 AbstractOptionStorage *findOption(const char *name) const;
96 * Calls AbstractOptionStorage::startSource() for all options,
97 * including subsections.
103 //! Name for the Options object.
105 //! Description title for the Options object.
107 //! Full description for the Options object.
108 std::string description_;
110 * List of subsections, in insertion order.
112 * This container contains only references to external objects; memory
113 * management is performed elsewhere.
115 SubSectionList subSections_;
117 * List of options, in insertion order.
119 * All objects in this container are owned by this object, and are
120 * freed in the destructor.
123 //! Options object that contains this object as a subsection, or NULL.