IO.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2022, Jose Luis Cercos-Pita <jlc@core-marine.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#pragma once
 
#include "Misc.hpp"
#include "Log.hpp"
#include <cstdint>
#include <string>
#include <vector>
#include <iostream>
#include <fstream>
#include <tuple>
 
namespace moordyn {
 
namespace io {
 
class DECLDIR IO : public LogUser
{
  public:
    IO(moordyn::Log* log);
 
    virtual ~IO() = default;
 
    void Save(const std::string filepath);
 
    void Load(const std::string filepath);
 
    virtual std::vector<uint64_t> Serialize(void) = 0;
 
    virtual uint64_t* Deserialize(const uint64_t* data) = 0;
 
  protected:
    ofstream MakeFile(const std::string filepath) const;
 
    std::tuple<uint64_t, uint64_t*> LoadFile(const std::string filepath) const;
 
    uint64_t Serialize(const uint64_t& i);
 
    uint64_t Serialize(const int64_t& i);
 
    uint64_t Serialize(const real& f);
 
    std::vector<uint64_t> Serialize(const vec& m);
 
    std::vector<uint64_t> Serialize(const vec6& m);
 
    std::vector<uint64_t> Serialize(const mat& m);
 
    std::vector<uint64_t> Serialize(const mat6& m);
 
    std::vector<uint64_t> Serialize(const quaternion& m);
 
    std::vector<uint64_t> Serialize(const XYZQuat& m);
 
    std::vector<uint64_t> Serialize(const std::vector<real>& l);
 
    std::vector<uint64_t> Serialize(const std::vector<vec>& l);
 
    std::vector<uint64_t> Serialize(const std::vector<vec6>& l);
 
    std::vector<uint64_t> Serialize(const std::vector<mat>& l);
 
    std::vector<uint64_t> Serialize(const std::vector<mat6>& l);
 
    inline std::vector<uint64_t> Serialize(
        const Eigen::Matrix<real, Eigen::Dynamic, Eigen::Dynamic>& l)
    {
        std::vector<uint64_t> data;
        const uint64_t n = l.rows();
        const uint64_t m = l.cols();
        data.reserve(2 + n * m);
        data.push_back(Serialize(n));
        data.push_back(Serialize(m));
        for (uint64_t i = 0; i < n; i++) {
            for (uint64_t j = 0; j < m; j++) {
                data.push_back(Serialize(l(i, j)));
            }
        }
        return data;
    }
 
    template<typename T>
    std::vector<uint64_t> Serialize(const std::vector<std::vector<T>>& l)
    {
        std::vector<uint64_t> data;
        const uint64_t n = l.size();
        data.push_back(Serialize(n));
        for (auto v : l) {
            std::vector<uint64_t> subdata = Serialize(v);
            data.insert(data.end(), subdata.begin(), subdata.end());
        }
        return data;
    }
 
    uint64_t* Deserialize(const uint64_t* in, uint64_t& out);
 
    uint64_t* Deserialize(const uint64_t* in, int64_t& out);
 
    uint64_t* Deserialize(const uint64_t* in, real& out);
 
    uint64_t* Deserialize(const uint64_t* in, vec& out);
 
    uint64_t* Deserialize(const uint64_t* in, vec6& out);
 
    uint64_t* Deserialize(const uint64_t* in, mat& out);
 
    uint64_t* Deserialize(const uint64_t* in, mat6& out);
 
    uint64_t* Deserialize(const uint64_t* in, quaternion& out);
 
    uint64_t* Deserialize(const uint64_t* in, XYZQuat& out);
 
    uint64_t* Deserialize(const uint64_t* in, std::vector<real>& out);
 
    uint64_t* Deserialize(const uint64_t* in, std::vector<vec>& out);
 
    uint64_t* Deserialize(const uint64_t* in, std::vector<vec6>& out);
 
    uint64_t* Deserialize(const uint64_t* in, std::vector<mat>& out);
 
    uint64_t* Deserialize(const uint64_t* in, std::vector<mat6>& out);
 
    uint64_t* Deserialize(
        const uint64_t* in,
        Eigen::Matrix<real, Eigen::Dynamic, Eigen::Dynamic>& out)
    {
        uint64_t* remaining;
        uint64_t n, m;
        remaining = Deserialize(in, n);
        remaining = Deserialize(remaining, m);
        if ((out.rows() != n) || (out.cols() != m))
            out.resize(n, m);
        for (unsigned int i = 0; i < n; i++) {
            for (unsigned int j = 0; j < m; j++) {
                remaining = Deserialize(remaining, out(i, j));
            }
        }
        return remaining;
    }
 
    template<typename T>
    uint64_t* Deserialize(const uint64_t* in, std::vector<std::vector<T>>& out)
    {
        uint64_t n;
        uint64_t* remaining = Deserialize(in, n);
        out.clear();
        out.reserve(n);
        for (unsigned int i = 0; i < n; i++) {
            std::vector<T> v;
            remaining = Deserialize(remaining, v);
            out.push_back(v);
        }
        return remaining;
    }
 
  private:
    bool _is_big_endian;
    uint8_t _min_major_version;
    uint8_t _min_minor_version;
};
 
} // ::io
 
} // ::moordyn