SDHierarchicalDatasetAccessor.h

Go to the documentation of this file.

// ============================================================================
// Copyright 2017-2021, Schlumberger
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ============================================================================

#pragma once

#include "DLL_EXPORT.h"
#include "SDDatasetDisposition.h"

#include <iterator>
#include <memory>
#include <string>
#include <vector>

namespace seismicdrive
{
    class Storage;

    /*******************************************************************************/ 
    struct SDHierarchicalMetaData
    {
        /*******************************************************************************/ 
        SDHierarchicalMetaData(const std::string &name = "", uint64_t nobjects = 0, uint64_t size = 0)
            : _name(name), _nobjects(nobjects), _size(size)
        {
        }

        /*******************************************************************************/ 
        bool operator == (const SDHierarchicalMetaData &rhs)
        {
            return this->_name == rhs._name && this->_nobjects == rhs._nobjects && this->_size == rhs._size;
        }

        std::string _name;

        uint64_t _nobjects;

        uint64_t _size;
    };

    /*******************************************************************************/ 
    class DLL_PUBLIC SDHierarchicalDatasetAccessor
    {
      private:
        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor(const SDDatasetDisposition disposition, void *storage, const std::string &gcsUrl, const std::string tag);

        /*******************************************************************************/ 
        void metadata_set(void *meta);

      public:
        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor(const SDDatasetDisposition disposition, Storage *storage, const std::string &gcsUrl, const std::string tag);

        /*******************************************************************************/ 
        ~SDHierarchicalDatasetAccessor();

        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor(SDHierarchicalDatasetAccessor &&sdhd) noexcept;

        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor &operator=(SDHierarchicalDatasetAccessor &&sdhd) noexcept;

        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor(const SDHierarchicalDatasetAccessor &op);

        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor &operator=(const SDHierarchicalDatasetAccessor &op);

        // --------------------------------------------------------------------------

        /*******************************************************************************/ 
        std::string get_tag() const;

        /*******************************************************************************/ 
        uint64_t node_add(const std::string &nodeName);

        /*******************************************************************************/ 
        uint64_t node_get(const std::string &nodeName) const;

        /*******************************************************************************/ 
        std::size_t object_write(const uint64_t nodeID, const std::string &objectName, const char *buffer, const std::size_t size);

        /*******************************************************************************/ 
        void object_read(const uint64_t nodeID, const std::string &objectName, char *buffer, size_t size);

        /*******************************************************************************/ 
        void object_delete(const uint64_t nodeID, const std::string &objectName);

        // --------------------------------------------------------------------------

        /*******************************************************************************/ 
        uint64_t node_count() const;

        /*******************************************************************************/ 
        std::size_t tot_byte_size() const;

        /*******************************************************************************/ 
        std::vector<SDHierarchicalMetaData> metadata_get() const;

        /*******************************************************************************/ 
        void metadata_set(const std::vector<SDHierarchicalMetaData> *meta);

        /*******************************************************************************/ 
        std::vector<std::string> node_names() const;

        /*******************************************************************************/ 
        std::vector<std::size_t> node_sizes() const;

        /*******************************************************************************/ 
        std::string node_name(const uint64_t nodeID) const;

        /*******************************************************************************/ 
        std::size_t node_size(const uint64_t nodeID) const;

        /*******************************************************************************/ 
        uint64_t object_count(const uint64_t nodeID) const;

        /*******************************************************************************/ 
        std::vector<std::string> object_names(const uint64_t nodeID) const;

        /*******************************************************************************/ 
        std::vector<std::size_t> object_sizes(const uint64_t nodeID) const;

        /*******************************************************************************/ 
        std::size_t object_size(const uint64_t nodeID, const std::string &object_name) const;

        /*******************************************************************************/ 
        void objects_info(const uint64_t nodeID, std::vector<std::string> &names, std::vector<std::size_t> &sizes);

      private:
#ifdef _MSC_VER
    #pragma warning(push)
    #pragma warning(disable : 4251)
#endif

        class Impl;

        std::unique_ptr<Impl> _impl;

#ifdef _MSC_VER
    #pragma warning(pop)
#endif

        friend class SDHierarchicalDatasetAcsTest;
    };

}