BaseStructureHeader.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_BASESTRUCTUREHEADER_H
#define EVIO_6_0_BASESTRUCTUREHEADER_H


#include <vector>
#include <cstring>
#include <cstdint>
#include <sstream>


#include "Util.h"
#include "ByteOrder.h"
#include "DataType.h"
#include "EvioException.h"


namespace evio {

    class BaseStructureHeader {

        friend class BaseStructure;
        friend class CompositeData;
        friend class EvioReader;
        friend class EvioReaderV4;
        friend class EventHeaderParser;
        friend class StructureTransformer;

    protected:

        uint32_t length = 0;

        uint32_t tag = 0;

        DataType dataType {DataType::UNKNOWN32};

        uint8_t padding = 0;

        uint8_t number = 0;

    protected:

        void setPadding(uint8_t pad);
        void copy(std::shared_ptr<BaseStructureHeader> const & head);

    public:

        BaseStructureHeader() = default;
        BaseStructureHeader(uint16_t tag, DataType const & dataType, uint8_t num = 0);

        uint8_t getNumber() const;
        void setNumber(uint8_t number);

        uint32_t getDataTypeValue() const;
        void setDataType(uint32_t type);

        void setDataType(DataType const & type);
        DataType getDataType() const;

        std::string getDataTypeName() const;
        uint8_t getPadding() const;

        uint32_t getLength() const;
        void setLength(uint32_t len);

        uint16_t getTag() const;
        void setTag(uint16_t tag);

        virtual uint32_t getDataLength()   {return 0;};
        virtual uint32_t getHeaderLength() {return 0;};
        virtual std::string   toString() {return "BaseStructureHeader";};

        virtual size_t write(std::shared_ptr<ByteBuffer> & dest) {return 0;}
        virtual size_t write(ByteBuffer & dest) {return 0;};
        virtual size_t write(uint8_t *dest, ByteOrder const & order) {return 0;};

    };
}

#endif //EVIO_6_0_BASESTRUCTUREHEADER_H