IBlockHeader.h

Go to the documentation of this file.

//
// Copyright 2020, Jefferson Science Associates, LLC.
// Subject to the terms in the LICENSE file found in the top-level directory.
//
// EPSCI Group
// Thomas Jefferson National Accelerator Facility
// 12000, Jefferson Ave, Newport News, VA 23606
// (757)-269-7100


#ifndef EVIO_6_0_IBLOCKHEADER_H
#define EVIO_6_0_IBLOCKHEADER_H


#include <cstdint>
#include <cstring>
#include <string>
#include <vector>
#include <stdexcept>


#include "ByteOrder.h"
#include "ByteBuffer.h"
#include "Compressor.h"


namespace evio {


    class IBlockHeader {

    public:

        static const uint32_t MAGIC_NUMBER = 0xc0da0100;

        static const uint32_t   MAGIC_OFFSET = 28;

        static const uint32_t   BIT_INFO_OFFSET = 20;

        static const uint32_t VERSION_MASK = 0xff;

        virtual uint32_t getSize() = 0;

        virtual uint32_t getNumber() = 0;

        virtual uint32_t getHeaderWords() = 0;

        virtual uint32_t getSourceId() = 0;

        virtual bool hasFirstEvent() = 0;

        virtual uint32_t getEventType() = 0;

        virtual uint32_t getVersion() = 0;

        virtual uint32_t getMagicNumber() = 0;

        virtual ByteOrder & getByteOrder() = 0;

        virtual size_t getBufferEndingPosition() = 0;

        virtual size_t getBufferStartingPosition() = 0;

        virtual void setBufferStartingPosition(size_t pos) = 0;

        virtual size_t nextBufferStartingPosition() = 0;

        virtual size_t firstEventStartingPosition() = 0;

        virtual size_t bytesRemaining(size_t position) = 0;

        virtual bool hasDictionary() = 0;

        virtual bool isLastBlock() = 0;

        virtual bool isCompressed() = 0;

        virtual Compressor::CompressionType getCompressionType() = 0;

        virtual size_t write(ByteBuffer & byteBuffer) = 0;

        virtual std::string toString() = 0;
    };



}

#endif //EVIO_6_0_IBLOCKHEADER_H