2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013,2014, 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.
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"
49 #include "optionmanagercontainer.h"
51 #include "gromacs/utility/uniqueptr.h"
56 class AbstractOptionStorage;
60 * Private implementation class for Options.
62 * Note that in addition to Options, the OptionsAssigner and OptionsIterator
63 * classes also directly access this class.
65 * \ingroup module_options
70 //! Smart pointer for managing an AbstractOptionStorage object.
71 typedef gmx_unique_ptr<AbstractOptionStorage>::type
72 AbstractOptionStoragePointer;
73 //! Convenience type for list of sections.
74 typedef std::vector<Options *> SubSectionList;
75 //! Convenience type for list of options.
76 typedef std::vector<AbstractOptionStoragePointer> OptionList;
78 //! Sets the name and title.
79 Impl(const char *name, const char *title);
83 * Finds a subsection by name.
85 * \param[in] name Name to search for.
86 * \returns Pointer to the found subsection, or NULL if not found.
90 Options *findSubSection(const char *name) const;
92 * Finds an option by name.
94 * \param[in] name Name to search for.
95 * \returns Pointer to the found option, or NULL if not found.
99 AbstractOptionStorage *findOption(const char *name) const;
102 * Calls AbstractOptionStorage::startSource() for all options,
103 * including subsections.
109 //! Name for the Options object.
111 //! Description title for the Options object.
113 //! Full description for the Options object.
114 std::string description_;
116 * Option managers set for this collection.
118 * This is non-empty only for the top-level Options object.
120 OptionManagerContainer managers_;
122 * List of subsections, in insertion order.
124 * This container contains only references to external objects; memory
125 * management is performed elsewhere.
127 SubSectionList subSections_;
129 * List of options, in insertion order.
131 * All objects in this container are owned by this object, and are
132 * freed in the destructor.
135 //! Options object that contains this object as a subsection, or NULL.