BlobHeader.h

Go to the documentation of this file.

// BlobHeader.h: Standard header for a blob
//
// Copyright (C) 2020 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef LOFAR_BLOB_BLOBHEADER_H
#define LOFAR_BLOB_BLOBHEADER_H
 
#include "common/DataConvert.h"
 
#include <cstring>
 
namespace dp3 {
namespace blob {
 
 
 
 
class BlobHeader {
  friend class BlobOStream;
  friend class BlobIStream;
 
 public:
  BlobHeader(int version = 0, unsigned int level = 0);
 
  dp3::common::DataFormat getDataFormat() const {
    return dp3::common::DataFormat(itsDataFormat);
  }
 
  void setLocalDataFormat();
 
  int getVersion() const {
    return (mustConvert()
                ? dp3::common::dataConvert(getDataFormat(), itsVersion)
                : itsVersion);
  }
 
  uint64_t getLength() const {
    return (mustConvert() ? dp3::common::dataConvert(getDataFormat(), itsLength)
                          : itsLength);
  }
 
  void setLength(uint64_t length) { itsLength = length; }
 
  bool mustConvert() const {
    return itsDataFormat != dp3::common::dataFormat();
  }
 
  unsigned int lengthOffset() const { return 0; }
 
  unsigned int getNameLength() const { return itsNameLength; }
 
  static uint32_t bobMagicValue() { return 0xbebebebe; }
 
  static uint32_t eobMagicValue() { return 0xbfbfbfbf; }
 
  bool checkMagicValue() const { return itsMagicValue == bobMagicValue(); }
 
  unsigned int getHeaderLength() const {
    return sizeof(BlobHeader) + itsNameLength;
  }
 
 private:
  uint64_t itsLength;
  uint32_t itsMagicValue;
  char itsVersion;
  char itsDataFormat;
  unsigned char itsLevel;
  unsigned char itsNameLength;
};
 
 
}  // namespace blob
}  // namespace dp3
 
#endif