src/gromacs/options/treesupport.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017, 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.
   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 /*! \libinternal \file
  36  * \brief
  37  * Declares functions for using keyvaluetree.h with Options.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_options
  42  */
  43 #ifndef GMX_OPTIONS_TREESUPPORT_H
  44 #define GMX_OPTIONS_TREESUPPORT_H
  45
  46 namespace gmx
  47 {
  48
  49 class IKeyValueTreeErrorHandler;
  50 class KeyValueTreeObject;
  51 class Options;
  52
  53 //! \cond libapi
  54
  55 /*! \libinternal \brief
  56  * Assigns option values from a given KeyValueTreeObject.
  57  *
  58  * Each property with a simple value (or an array of simple values) is assigned
  59  * to an option with the same name.  Objects and arrays of objects are assigned
  60  * to sections with the same name.
  61  *
  62  * \ingroup module_options
  63  */
  64 void assignOptionsFromKeyValueTree(Options                   *options,
  65                                    const KeyValueTreeObject  &tree,
  66                                    IKeyValueTreeErrorHandler *errorHandler);
  67 /*! \libinternal \brief
  68  * Checks that a given KeyValueTreeObject can be assigned to given Options.
  69  *
  70  * Throws an exception if `tree` contains any values that are not recognized by
  71  * `options`.  Does not verify the type of the values, only that an option with
  72  * the correct names exists.
  73  *
  74  * \ingroup module_options
  75  */
  76 void checkForUnknownOptionsInKeyValueTree(const KeyValueTreeObject &tree,
  77                                           const Options            &options);
  78 /*! \libinternal \brief
  79  * Adjusts a KeyValueTreeObject to the structure of given Options.
  80  *
  81  * Assumes that all values in the input KeyValueTreeObject are valid values for
  82  * the options.  The output has all the values in the input, but in the order
  83  * they are in the options.  Values are also converted to the native type for
  84  * the underlying option (e.g., strings are parsed to integers if the option
  85  * accepts those).  For any option that does not have a corresponding value in
  86  * the input, the output has it with a default value (if one exists for the
  87  * option).
  88  *
  89  * Any values in `tree` that do not have matching options are not present in
  90  * the output.  If this is not desirable, call
  91  * checkForUnknownOptionsInKeyValueTree() before calling this function to
  92  * ensure that no such values are present.
  93  *
  94  * Does not currently work for option sections in an array.
  95  *
  96  * \ingroup module_options
  97  */
  98 KeyValueTreeObject
  99 adjustKeyValueTreeFromOptions(const KeyValueTreeObject &tree,
 100                               const Options            &options);
 101
 102 //! \endcond
 103
 104 } // namespace gmx
 105
 106 #endif