src/testutils/include/testutils/tprfilegenerator.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  * \brief
  37  * Helper for generating reusuable TPR files for tests within the same test binary.
  38  *
  39  * \ingroup module_testutils
  40  * \author Paul Bauer <paul.bauer.q@gmail.com>
  41  */
  42 #ifndef GMX_TESTUTILS_TPRFILEGENERATOR_H
  43 #define GMX_TESTUTILS_TPRFILEGENERATOR_H
  44
  45 #include <memory>
  46 #include <string>
  47
  48 #include "testutils/testfilemanager.h"
  49
  50 namespace gmx
  51 {
  52 namespace test
  53 {
  54
  55 class TestFileManager;
  56
  57 /*! \libinternal \brief
  58  * Helper to bundle generated TPR and the file manager to clean it up.
  59  */
  60 class TprAndFileManager
  61 {
  62 public:
  63     /*! \brief
  64      * Generates the file when needed.
  65      *
  66      * \param[in] name The basename of the input files and the generated TPR.
  67      */
  68     TprAndFileManager(const std::string& name);
  69     //! Access to the string.
  70     const std::string& tprName() const { return tprFileName_; }
  71
  72 private:
  73     //! Tpr file name.
  74     std::string tprFileName_;
  75     //! Filemanager, needed to clean up the file later.
  76     TestFileManager fileManager_;
  77 };
  78
  79 } // namespace test
  80 } // namespace gmx
  81
  82 #endif