2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
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.
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.
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.
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.
36 * \brief Defines the checkpoint data structure for the modular simulator
38 * \author Pascal Merz <pascal.merz@me.com>
39 * \ingroup module_mdtypes
44 #include "checkpointdata.h"
46 #include "gromacs/utility/iserializer.h"
47 #include "gromacs/utility/keyvaluetreeserializer.h"
48 #include "gromacs/utility/textwriter.h"
53 void ReadCheckpointDataHolder::deserialize(ISerializer* serializer)
55 GMX_RELEASE_ASSERT(serializer->reading(),
56 "Tried to deserialize using a serializing ISerializer object.");
58 checkpointTree_ = deserializeKeyValueTree(serializer);
61 void WriteCheckpointDataHolder::serialize(ISerializer* serializer)
63 GMX_RELEASE_ASSERT(!serializer->reading(),
64 "Tried to serialize using a deserializing ISerializer object.");
66 serializeKeyValueTree(outputTreeBuilder_.build(), serializer);
68 // Tree builder should not be used after build() (see docstring)
69 // Make new builder to leave object in valid state
70 outputTreeBuilder_ = KeyValueTreeBuilder();
73 bool ReadCheckpointDataHolder::keyExists(const std::string& key) const
75 return checkpointTree_.keyExists(key);
78 std::vector<std::string> ReadCheckpointDataHolder::keys() const
80 std::vector<std::string> keys;
81 for (const auto& property : checkpointTree_.properties())
83 keys.emplace_back(property.key());
88 ReadCheckpointData ReadCheckpointDataHolder::checkpointData(const std::string& key) const
90 return ReadCheckpointData(checkpointTree_[key].asObject());
93 void ReadCheckpointDataHolder::dump(FILE* out) const
97 TextWriter textWriter(out);
98 dumpKeyValueTree(&textWriter, checkpointTree_);
102 WriteCheckpointData WriteCheckpointDataHolder::checkpointData(const std::string& key)
104 hasCheckpointDataBeenRequested_ = true;
105 return WriteCheckpointData(outputTreeBuilder_.rootObject().addObject(key));
108 bool WriteCheckpointDataHolder::empty() const
110 return !hasCheckpointDataBeenRequested_;