src/testutils/refdata_xml.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2019,2020, 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 /*! \internal \file
  36  * \brief
  37  * Declares functions for reference data XML persistence.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_testutils
  41  */
  42 #ifndef GMX_TESTUTILS_REFDATA_XML_H
  43 #define GMX_TESTUTILS_REFDATA_XML_H
  44
  45 #include <string>
  46
  47 #include "refdata_impl.h"
  48
  49 namespace gmx
  50 {
  51 namespace test
  52 {
  53
  54 class ReferenceDataEntry;
  55
  56 //! \cond internal
  57 /*! \internal
  58  * \brief
  59  * Loads reference data from an XML file.
  60  *
  61  * \param[in] path  Path to the file from which the data is loaded.
  62  * \returns   Root entry for the reference data parsed from the file.
  63  * \throws    TestException if there is a problem reading the file.
  64  *
  65  * \ingroup module_testutils
  66  */
  67 ReferenceDataEntry::EntryPointer readReferenceDataFile(const std::string& path);
  68 /*! \internal
  69  * \brief
  70  * Saves reference data to an XML file.
  71  *
  72  * \param[in] path  Path to the file to which the data is saved.
  73  * \param[in] root  Root entry for the reference data to write.
  74  * \throws    TestException if there is a problem writing the file.
  75  *
  76  * \ingroup module_testutils
  77  */
  78 void writeReferenceDataFile(const std::string& path, const ReferenceDataEntry& root);
  79 //! \endcond
  80
  81 } // namespace test
  82 } // namespace gmx
  83
  84 #endif