BinaryStreamWriter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
 
#include <cstdint>
#include <iosfwd>
#include <string>
#include <vector>
 
namespace Mantid {
namespace Kernel {
 
// Forward declarations
template <typename T> class Matrix;
 
class MANTID_KERNEL_DLL BinaryStreamWriter {
public:
  enum class MatrixOrdering { RowMajor, ColumnMajor };
 
  BinaryStreamWriter(std::ostream &ofstrm);
 
  BinaryStreamWriter &operator<<(const int16_t &value);
  BinaryStreamWriter &operator<<(const int32_t &value);
  BinaryStreamWriter &operator<<(const int64_t &value);
  BinaryStreamWriter &operator<<(const float &value);
  BinaryStreamWriter &operator<<(const double &value);
  BinaryStreamWriter &operator<<(const std::string &value);
  BinaryStreamWriter &operator<<(const uint16_t &value);
  BinaryStreamWriter &operator<<(const uint32_t &value);
 
  BinaryStreamWriter &write(const std::vector<int16_t> &value, const size_t nvals);
  BinaryStreamWriter &write(const std::vector<int32_t> &value, const size_t nvals);
  BinaryStreamWriter &write(const std::vector<int64_t> &value, const size_t nvals);
  BinaryStreamWriter &write(const std::vector<float> &value, const size_t nvals);
  BinaryStreamWriter &write(const std::vector<double> &value, const size_t nvals);
  BinaryStreamWriter &write(const std::string &value, const size_t length);
 
  BinaryStreamWriter &write(const std::vector<std::string> &value, const std::vector<int32_t> &shape,
                            MatrixOrdering order);
  BinaryStreamWriter &write(const Kernel::Matrix<float> &value, const std::vector<int32_t> &shape,
                            MatrixOrdering order);
  BinaryStreamWriter &write(const Kernel::Matrix<double> &value, const std::vector<int32_t> &shape,
                            MatrixOrdering order);
 
private:
  std::ostream &m_ofstrm;
  uint64_t m_strLengthSize;
};
 
} // namespace Kernel
} // namespace Mantid