src/gromacs/utility/inmemoryserializer.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 gmx::ISerializer implementation for in-memory serialization.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_INMEMORYSERIALIZER_H
  44 #define GMX_UTILITY_INMEMORYSERIALIZER_H
  45
  46 #include <vector>
  47
  48 #include "gromacs/utility/classhelpers.h"
  49 #include "gromacs/utility/iserializer.h"
  50
  51 namespace gmx
  52 {
  53
  54 class InMemorySerializer : public ISerializer
  55 {
  56     public:
  57         InMemorySerializer();
  58         virtual ~InMemorySerializer();
  59
  60         std::vector<char> finishAndGetBuffer();
  61
  62         // From ISerializer
  63         virtual bool reading() const { return false; }
  64         virtual void doUChar(unsigned char *value);
  65         virtual void doInt(int *value);
  66         virtual void doInt64(gmx_int64_t *value);
  67         virtual void doFloat(float *value);
  68         virtual void doDouble(double *value);
  69         virtual void doString(std::string *value);
  70
  71     private:
  72         class Impl;
  73
  74         PrivateImplPointer<Impl> impl_;
  75 };
  76
  77 class InMemoryDeserializer : public ISerializer
  78 {
  79     public:
  80         explicit InMemoryDeserializer(const std::vector<char> &buffer);
  81         virtual ~InMemoryDeserializer();
  82
  83         // From ISerializer
  84         virtual bool reading() const { return true; }
  85         virtual void doUChar(unsigned char *value);
  86         virtual void doInt(int *value);
  87         virtual void doInt64(gmx_int64_t *value);
  88         virtual void doFloat(float *value);
  89         virtual void doDouble(double *value);
  90         virtual void doString(std::string *value);
  91
  92     private:
  93         class Impl;
  94
  95         PrivateImplPointer<Impl> impl_;
  96 };
  97
  98 } // namespace gmx
  99
 100 #endif