src/gromacs/utility/keyvaluetreemdpwriter.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2019, 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 a function to write a flat key-value tree to look like
  38  * old-style mdp output.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_KEYVALUETREEMDPWRITER_H
  45 #define GMX_UTILITY_KEYVALUETREEMDPWRITER_H
  46
  47 namespace gmx
  48 {
  49
  50 class KeyValueTreeObject;
  51 class TextWriter;
  52
  53 /*! \brief Write a flat key-value \c tree to \c writer in mdp style.
  54  *
  55  * Sub-objects will output nothing, so they can be used to
  56  * contain a special key-value pair to create a comment, as
  57  * well as the normal key and value. The comment pair will
  58  * have a key of "comment", and the value will be used as a
  59  * comment (if non-empty). */
  60 void writeKeyValueTreeAsMdp(TextWriter* writer, const KeyValueTreeObject& tree);
  61
  62 } // namespace gmx
  63
  64 #endif