src/gromacs/utility/iserializer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017, 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 a generic serialization interface that supports both directions.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_ISERIALIZER_H
  44 #define GMX_UTILITY_ISERIALIZER_H
  45
  46 #include <string>
  47
  48 #include "gromacs/utility/basedefinitions.h"
  49
  50 namespace gmx
  51 {
  52
  53 /*! \libinternal
  54  * \brief Interface for types that convert standard data types into a
  55  * form suitable for storage or transfer.
  56  *
  57  * Different implementations could suit MPI, file I/O, or in-memory
  58  * conversion. */
  59 class ISerializer
  60 {
  61     public:
  62         //! Destructor.
  63         virtual ~ISerializer() {}
  64         /*! \brief Returns whether the serializer is reading or
  65          * writing, because details like memory management vary
  66          * accordingly. */
  67         virtual bool reading() const = 0;
  68         //! \brief Serialize values of different types.
  69         ///@{
  70         virtual void doUChar(unsigned char *value) = 0;
  71         virtual void doInt(int *value)             = 0;
  72         virtual void doInt64(gmx_int64_t *value)   = 0;
  73         virtual void doFloat(float *value)         = 0;
  74         virtual void doDouble(double *value)       = 0;
  75         virtual void doString(std::string *value)  = 0;
  76         ///@}
  77 };
  78
  79 } // namespace gmx
  80
  81 #endif