src/gromacs/options.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \defgroup module_options Extensible Handling of Options
  36  * \ingroup group_utilitymodules
  37  * \brief
  38  * Provides functionality for handling options.
  39  *
  40  * <H3>Basic Use</H3>
  41  *
  42  * Basic interface for providing options is implemented by the Options class
  43  * and classes defined in basicoptions.h for specifying individual options.
  44  * Only these are needed if a class wants to provide a set of standard options.
  45  * When creating an Options object and adding options, it is possible to add
  46  * descriptions for individual options as well as for the whole set of options.
  47  * These can then be used to write out help text.
  48  *
  49  * Module \ref module_commandline implements classes that assign option values
  50  * from command line and produce help for programs that use the command line
  51  * parser.
  52  *
  53  * \if libapi
  54  * <H3>Advanced Use (in library API)</H3>
  55  *
  56  * It is possible to extend the module with new option types and/or parsers for
  57  * option values.
  58  *
  59  * To implement new option types, it is necessary to subclass the templates
  60  * OptionTemplate and OptionStorageTemplate with the type of the values that
  61  * the option should provide as the template argument.  After this is done, it
  62  * is possible to add options of this new type using Options::addOption().
  63  *
  64  * To implement new parsers, one can use OptionsAssigner, which provides an
  65  * interface to set values in an Options object.
  66  *
  67  * There is also an interface to iterate over all options in an Options object.
  68  * One should implement the OptionsVisitor interface, and then use
  69  * OptionsIterator to apply this visitor to the Options object.
  70  * \endif
  71  *
  72  * \author Teemu Murtola <teemu.murtola@gmail.com>
  73  */
  74 /*! \file
  75  * \brief
  76  * Public API convenience header for handling of options.
  77  *
  78  * \author Teemu Murtola <teemu.murtola@gmail.com>
  79  * \inpublicapi
  80  * \ingroup module_options
  81  */
  82 #ifndef GMX_OPTIONS_H
  83 #define GMX_OPTIONS_H
  84
  85 #include "options/basicoptions.h"
  86 #include "options/filenameoption.h"
  87 #include "options/options.h"
  88
  89 #endif