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
31 /*! \defgroup module_options Extensible Handling of Options
32 * \ingroup group_utilitymodules
34 * Provides functionality for handling options.
38 * Basic interface for providing options is implemented by the Options class
39 * and classes defined in basicoptions.h for specifying individual options.
40 * Only these are needed if a class wants to provide a set of standard options.
41 * When creating an Options object and adding options, it is possible to add
42 * descriptions for individual options as well as for the whole set of options.
43 * These can then be used to write out help text.
45 * Module \ref module_commandline implements classes that assign option values
46 * from command line and produce help for programs that use the command line
50 * <H3>Advanced Use (in library API)</H3>
52 * It is possible to extend the module with new option types and/or parsers for
55 * To implement new option types, it is necessary to subclass the templates
56 * OptionTemplate and OptionStorageTemplate with the type of the values that
57 * the option should provide as the template argument. After this is done, it
58 * is possible to add options of this new type using Options::addOption().
60 * To implement new parsers, one can use OptionsAssigner, which provides an
61 * interface to set values in an Options object.
63 * There is also an interface to iterate over all options in an Options object.
64 * One should implement the OptionsVisitor interface, and then use
65 * OptionsIterator to apply this visitor to the Options object.
68 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
72 * Public API convenience header for handling of options.
74 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
76 * \ingroup module_options
81 #include "options/basicoptioninfo.h"
82 #include "options/basicoptions.h"
83 #include "options/filenameoptioninfo.h"
84 #include "options/filenameoption.h"
85 #include "options/options.h"