3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares private implementation class for gmx::Options.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
36 * \ingroup module_options
38 #ifndef GMX_OPTIONS_OPTIONS_IMPL_H
39 #define GMX_OPTIONS_OPTIONS_IMPL_H
44 #include "abstractoption.h"
50 class AbstractOptionStorage;
53 * Private implementation class for Options.
55 * Note that in addition to Options, the OptionsAssigner and OptionsIterator
56 * classes also directly access this class.
58 * \ingroup module_options
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;
68 //! Sets the name and title.
69 Impl(const char *name, const char *title);
73 * Finds a subsection by name.
75 * \param[in] name Name to search for.
76 * \returns Pointer to the found subsection, or NULL if not found.
80 Options *findSubSection(const char *name) const;
82 * Finds an option by name.
84 * \param[in] name Name to search for.
85 * \returns Pointer to the found option, or NULL if not found.
89 AbstractOptionStorage *findOption(const char *name) const;
92 * Calls AbstractOptionStorage::startSource() for all options,
93 * including subsections.
99 //! Name for the Options object.
101 //! Description title for the Options object.
103 //! Full description for the Options object.
104 std::string description_;
106 * List of subsections, in insertion order.
108 * This container contains only references to external objects; memory
109 * management is performed elsewhere.
111 SubSectionList subSections_;
113 * List of options, in insertion order.
115 * All objects in this container are owned by this object, and are
116 * freed in the destructor.
119 //! Options object that contains this object as a subsection, or NULL.