BlobOStream.h

Go to the documentation of this file.

// BlobOStream.h: Output stream for a blob
//
// Copyright (C) 2020 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef LOFAR_BLOB_BLOBOSTREAM_H
#define LOFAR_BLOB_BLOBOSTREAM_H
 
#include "BlobOBuffer.h"
 
#include <stack>
#include <vector>
#include <string>
#include <complex>
#include <cstring>
 
namespace dp3 {
namespace blob {
 
 
 
 
class BlobOStream {
 public:
  explicit BlobOStream(BlobOBuffer&);
 
  ~BlobOStream();
 
  void clear();
 
  uint64_t size() const { return itsCurLength; }
 
  //
  //
  unsigned int putStart(int objectVersion);
  unsigned int putStart(const std::string& objectType, int objectVersion);
  unsigned int putStart(const char* objectType, int objectVersion);
 
  uint64_t putEnd();
 
  BlobOStream& operator<<(const bool& value);
  BlobOStream& operator<<(const char& value);
  BlobOStream& operator<<(const int8_t& value);
  BlobOStream& operator<<(const uint8_t& value);
  BlobOStream& operator<<(const int16_t& value);
  BlobOStream& operator<<(const uint16_t& value);
  BlobOStream& operator<<(const int32_t& value);
  BlobOStream& operator<<(const uint32_t& value);
  BlobOStream& operator<<(const int64_t& value);
  BlobOStream& operator<<(const uint64_t& value);
  BlobOStream& operator<<(const float& value);
  BlobOStream& operator<<(const double& value);
  BlobOStream& operator<<(const std::complex<float>& value);
  BlobOStream& operator<<(const std::complex<double>& value);
  BlobOStream& operator<<(const std::string& value);
  BlobOStream& operator<<(const char* value);
 
  void put(const bool* values, uint64_t nrval);
  void put(const char* values, uint64_t nrval);
  void put(const int8_t* values, uint64_t nrval);
  void put(const uint8_t* values, uint64_t nrval);
  void put(const int16_t* values, uint64_t nrval);
  void put(const uint16_t* values, uint64_t nrval);
  void put(const int32_t* values, uint64_t nrval);
  void put(const uint32_t* values, uint64_t nrval);
  void put(const int64_t* values, uint64_t nrval);
  void put(const uint64_t* values, uint64_t nrval);
  void put(const float* values, uint64_t nrval);
  void put(const double* values, uint64_t nrval);
  void put(const std::complex<float>* values, uint64_t nrval);
  void put(const std::complex<double>* values, uint64_t nrval);
  void put(const std::string* values, uint64_t nrval);
 
  void put(const std::vector<bool>& values);
  template <class T>
  void put(const std::vector<T>& values);
 
  void putBoolVec(const std::vector<bool>& values);
 
  int64_t setSpace(uint64_t nbytes);
 
  unsigned int align(unsigned int n);
 
  int64_t tellPos() const;
 
 private:
  unsigned int doPutStart(const char* objectType, unsigned int nrc,
                          int objectVersion);
 
  void putBuf(const void* buf, uint64_t sz);
 
  void checkPut() const;
  void throwPut() const;
 
  bool itsSeekable;
  uint64_t itsCurLength;
  unsigned int itsLevel;
  std::stack<uint64_t> itsObjLen;
  std::stack<int64_t> itsObjPtr;
  BlobOBuffer* itsStream;
};
 
 
inline void BlobOStream::clear() {
  itsCurLength = 0;
  itsLevel = 0;
}
 
inline unsigned int BlobOStream::putStart(int objectVersion) {
  return doPutStart("", 0, objectVersion);
}
 
inline unsigned int BlobOStream::putStart(const std::string& objectType,
                                          int objectVersion) {
  return doPutStart(objectType.data(), objectType.size(), objectVersion);
}
 
inline unsigned int BlobOStream::putStart(const char* objectType,
                                          int objectVersion) {
  return doPutStart(objectType, strlen(objectType), objectVersion);
}
 
inline int64_t BlobOStream::tellPos() const { return itsStream->tellPos(); }
 
template <class T>
inline void BlobOStream::put(const std::vector<T>& vec) {
  operator<<(uint64_t(vec.size()));
  put(&vec[0], vec.size());
}
inline void BlobOStream::put(const std::vector<bool>& vec) {
  operator<<(uint64_t(vec.size()));
  putBoolVec(vec);
}
 
inline void BlobOStream::checkPut() const {
  if (itsLevel == 0) throwPut();
}
 
}  // namespace blob
}  // namespace dp3
 
#endif