Serialization.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_SERIALIZATION_HPP
#define CUBBYFLOW_SERIALIZATION_HPP

#include <Core/Array/ArrayView.hpp>

#include <vector>

namespace CubbyFlow
{
class Serializable
{
 public:
    Serializable() = default;

    Serializable(const Serializable&) = default;

    Serializable(Serializable&&) noexcept = default;

    virtual ~Serializable() = default;

    Serializable& operator=(const Serializable&) = default;

    Serializable& operator=(Serializable&&) noexcept = default;

    virtual void Serialize(std::vector<uint8_t>* buffer) const = 0;

    virtual void Deserialize(const std::vector<uint8_t>& buffer) = 0;
};

void Serialize(const Serializable* serializable, std::vector<uint8_t>* buffer);

void Serialize(const uint8_t* data, size_t size, std::vector<uint8_t>* buffer);

template <typename T>
void Serialize(const ConstArrayView1<T>& array, std::vector<uint8_t>* buffer);

void Deserialize(const std::vector<uint8_t>& buffer,
                 Serializable* serializable);

void Deserialize(const std::vector<uint8_t>& buffer,
                 std::vector<uint8_t>* data);

template <typename T>
void Deserialize(const std::vector<uint8_t>& buffer, Array1<T>* array);
}  // namespace CubbyFlow

#include <Core/Utils/Serialization-Impl.hpp>

#endif