src/api/cpp/md_impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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 #ifndef GMXAPI_MD_IMPL_H
  36 #define GMXAPI_MD_IMPL_H
  37 /*! \file
  38  * \brief Declarations for molecular dynamics API implementation details.
  39  *
  40  * \ingroup gmxapi
  41  */
  42
  43 #include <memory>
  44
  45 #include "gmxapi/gmxapi.h"
  46 #include "gmxapi/md.h"
  47
  48 namespace gmxapi
  49 {
  50
  51 class MDWorkSpec;
  52
  53 /*!
  54  * \brief Implementation class to hide guts of MDHolder
  55  *
  56  * Holds the gmxapi interface for an object that can help instantiate the gmx::MdRunner
  57  */
  58 class MDHolder::Impl
  59 {
  60 public:
  61     /*!
  62      * \brief Construct by capturing a messaging object.
  63      *
  64      * \param spec operations specified for a workflow and the means to instantiate them.
  65      */
  66     explicit Impl(std::shared_ptr<MDWorkSpec>&& spec);
  67
  68     /*!
  69      * \brief Shared ownership of the gmxapi object used for higher level message passing.
  70      */
  71     std::shared_ptr<MDWorkSpec> spec_{ nullptr };
  72 };
  73
  74 } // namespace gmxapi
  75
  76 #endif // header guard