src/testutils/xvgtest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015, 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 function to add the content of an xvg file to a checker.
  38  *
  39  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS_XVGTESTS_H
  44 #define GMX_TESTUTILS_XVGTESTS_H
  45
  46 #include <string>
  47
  48 namespace gmx
  49 {
  50
  51 class TextInputStream;
  52
  53 namespace test
  54 {
  55
  56 class TestReferenceChecker;
  57
  58 /*! \brief
  59  * Adds content of xvg file to TestReferenceChecker object.
  60  *
  61  * A stream of strings is parsed. The columns
  62  * are analyzed with a relative tolerance provided by the input.
  63  * Xmgrace formatting is ignored and only multi-column data is
  64  * understood.
  65  *
  66  * \param[in] input       Object returning the lines of the file/data
  67  *                        one by one.
  68  * \param[in,out] checker The checker object.
  69  */
  70 void checkXvgFile(TextInputStream      *input,
  71                   TestReferenceChecker *checker);
  72
  73
  74 } // namespace test
  75
  76 } // namespace gmx
  77
  78 #endif