IEvioCompactReader.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_IEVIOCOMPACTREADER_H
#define EVIO_6_0_IEVIOCOMPACTREADER_H


#include <memory>
#include <vector>


#include "ByteBuffer.h"
#include "ByteOrder.h"
#include "EvioException.h"
#include "EvioNode.h"
#include "EvioXMLDictionary.h"
#include "IBlockHeader.h"


namespace evio {


    class IEvioCompactReader {

    public:

        virtual bool isFile() = 0;

        virtual bool isCompressed() = 0;

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

        virtual bool isClosed() = 0;

        virtual ByteOrder getByteOrder() = 0;

        virtual uint32_t getEvioVersion() = 0;

        virtual std::string getPath() = 0;

        virtual ByteOrder getFileByteOrder() = 0;

        virtual std::string getDictionaryXML() = 0;

        virtual std::shared_ptr<EvioXMLDictionary> getDictionary() = 0;

        virtual bool hasDictionary() = 0;

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

        virtual size_t fileSize() = 0;

        virtual std::shared_ptr<EvioNode> getEvent(size_t eventNumber) = 0;

        virtual std::shared_ptr<EvioNode> getScannedEvent(size_t eventNumber) = 0;

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

        virtual void searchEvent(size_t eventNumber, uint16_t tag, uint8_t num,
                                 std::vector<std::shared_ptr<EvioNode>> & vec) = 0;

        virtual void searchEvent(size_t eventNumber, std::string const & dictName,
                                 std::shared_ptr<EvioXMLDictionary> & dictionary,
                                 std::vector<std::shared_ptr<EvioNode>> & vec) = 0;

        virtual std::shared_ptr<ByteBuffer> removeEvent(size_t eventNumber) = 0;

        virtual std::shared_ptr<ByteBuffer> removeStructure(std::shared_ptr<EvioNode> & removeNode) = 0;

        virtual std::shared_ptr<ByteBuffer> addStructure(size_t eventNumber, ByteBuffer & addBuffer) = 0;

        virtual std::shared_ptr<ByteBuffer> getData(std::shared_ptr<EvioNode> & node) = 0;

        virtual std::shared_ptr<ByteBuffer> getData(std::shared_ptr<EvioNode> & node, bool copy) = 0;

        virtual std::shared_ptr<ByteBuffer> getData(std::shared_ptr<EvioNode> & node,
                                                    std::shared_ptr<ByteBuffer> & buf) = 0;

        virtual std::shared_ptr<ByteBuffer> getData(std::shared_ptr<EvioNode> & node,
                                                    std::shared_ptr<ByteBuffer> & buf, bool copy) = 0;

        virtual std::shared_ptr<ByteBuffer> getEventBuffer(size_t eventNumber) = 0;

        virtual std::shared_ptr<ByteBuffer> getEventBuffer(size_t eventNumber, bool copy) = 0;

        virtual std::shared_ptr<ByteBuffer> getStructureBuffer(std::shared_ptr<EvioNode> & node) = 0;

        virtual std::shared_ptr<ByteBuffer> getStructureBuffer(std::shared_ptr<EvioNode> & node, bool copy) = 0;

        virtual void close() = 0;

        virtual uint32_t getEventCount() = 0;

        virtual uint32_t getBlockCount() = 0;

        virtual void toFile(std::string const & fileName) = 0;
    };


}

#endif //EVIO_6_0_IEVIOCOMPACTREADER_H