IEvioReader.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_IEVIOREADER_H
#define EVIO_6_0_IEVIOREADER_H


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


#include "ByteOrder.h"
#include "ByteBuffer.h"
#include "IBlockHeader.h"
#include "EventParser.h"


namespace evio {


    class IEvioReader {

    public:

        enum ReadWriteStatus {
            SUCCESS = 0, END_OF_FILE, CANNOT_OPEN_FILE, EVIO_EXCEPTION, UNKNOWN_ERROR
        };

        virtual void setBuffer(std::shared_ptr<ByteBuffer> & buf) = 0;

        virtual bool isClosed() = 0;

        virtual bool checkBlockNumberSequence() = 0;

        virtual ByteOrder & getByteOrder() = 0;

        virtual uint32_t getEvioVersion() = 0;

        virtual std::string getPath() = 0;

        virtual std::shared_ptr<EventParser> & getParser() = 0;

        virtual void setParser(std::shared_ptr<EventParser> & evParser) = 0;

        virtual std::string getDictionaryXML() = 0;

        virtual bool hasDictionaryXML() = 0;

        virtual std::shared_ptr<EvioEvent> getFirstEvent() = 0;

        virtual bool hasFirstEvent() = 0;

        virtual size_t getNumEventsRemaining() = 0;

        virtual std::shared_ptr<ByteBuffer> getByteBuffer() = 0;

        virtual size_t fileSize() = 0;

        virtual std::shared_ptr<IBlockHeader> getFirstBlockHeader() = 0;

        virtual std::shared_ptr<EvioEvent> getEvent(size_t index) = 0;

        virtual std::shared_ptr<EvioEvent> parseEvent(size_t index) = 0;

        virtual std::shared_ptr<EvioEvent> nextEvent() = 0;

        virtual std::shared_ptr<EvioEvent> parseNextEvent() = 0;

        virtual void parseEvent(std::shared_ptr<EvioEvent> evioEvent) = 0;

        virtual uint32_t getEventArray(size_t evNumber, std::vector<uint8_t> & vec) = 0;

        virtual uint32_t getEventBuffer(size_t evNumber, ByteBuffer & buf) = 0;

        virtual void rewind() = 0;

        virtual ssize_t position() = 0;

        virtual void close() = 0;

        virtual std::shared_ptr<IBlockHeader> getCurrentBlockHeader() = 0;

        virtual std::shared_ptr<EvioEvent> gotoEventNumber(size_t evNumber) = 0;

        virtual size_t getEventCount() = 0;

        virtual size_t getBlockCount() = 0;
    };

}

#endif //EVIO_6_0_IEVIOREADER_H