src/api/cpp/include/gmxapi/compat/mdparams.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 /*! \file
  37  * \brief Compatibility header for simulation parameters.
  38  *
  39  * \author M. Eric Irrgang <ericirrgang@gmail.com>
  40  * \ingroup gmxapi_compat
  41  */
  42
  43 #ifndef GMXAPICOMPAT_MDPARAMS_H
  44 #define GMXAPICOMPAT_MDPARAMS_H
  45
  46 #include <map>
  47 #include <memory>
  48 #include <string>
  49 #include <vector>
  50
  51 #include "gmxapi/gmxapicompat.h"
  52 #include "gmxapi/gmxapi.h"
  53
  54 namespace gmxapicompat
  55 {
  56
  57 // Forward declaration for private implementation class for GmxMdParams
  58 class GmxMdParamsImpl;
  59
  60 class GmxMdParams
  61 {
  62 public:
  63     GmxMdParams();
  64     ~GmxMdParams();
  65     GmxMdParams(const GmxMdParams&) = delete;
  66     GmxMdParams& operator=(const GmxMdParams&) = delete;
  67     GmxMdParams(GmxMdParams&& /*unused*/) noexcept;
  68     GmxMdParams& operator=(GmxMdParams&& /*unused*/) noexcept;
  69
  70     explicit GmxMdParams(std::unique_ptr<GmxMdParamsImpl>&& impl);
  71
  72     std::unique_ptr<GmxMdParamsImpl> params_;
  73 };
  74
  75 /*!
  76  * \brief Get the list of parameter key words.
  77  *
  78  * \param params molecular simulation parameters object reference.
  79  * \return A new vector of parameter names.
  80  *
  81  * \note The returned data is a copy. Modifying the return value has no affect on
  82  * the original object inspected.
  83  */
  84 std::vector<std::string> keys(const GmxMdParams& params);
  85
  86 } // end namespace gmxapicompat
  87
  88 #endif // GMXAPICOMPAT_MDPARAMS_H