SDHierarchicalDataset.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 "SDHierarchicalDatasetAccessor.h"
#include "SDManager.h"

#include <memory>
#include <unordered_map>

namespace seismicdrive
{
    struct HttpContext;

    /*******************************************************************************/ 
    class DLL_PUBLIC SDHierarchicalDataset
    {
      public:
        /*******************************************************************************/ 
        SDHierarchicalDataset(SDManager *sdmanager, const std::string &sdfilename, const bool log = false);

        /*******************************************************************************/ 
        SDHierarchicalDataset(SDManager *sdmanager, const std::string &sdfilename, const std::string &filetype, const bool log = false);

        /*******************************************************************************/ 
        ~SDHierarchicalDataset();

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

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

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

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

        /*******************************************************************************/ 
        void open(const SDDatasetDisposition disposition);

        /*******************************************************************************/ 
        void open(const SDDatasetDisposition disposition, const std::string &legaltag);

        /*******************************************************************************/ 
        void open(const SDDatasetDisposition disposition, const std::string &legaltag, const std::string &wid);

        /*******************************************************************************/ 
        void open(const SDDatasetDisposition disposition, const std::unordered_map<std::string, std::string> &args);

        /*******************************************************************************/ 
        void close();

        /*******************************************************************************/ 
        void flush();

        /*******************************************************************************/ 
        bool exist() const;

        /*******************************************************************************/ 
        bool exists() const;

        /*******************************************************************************/ 
        bool isOpen();

        /*******************************************************************************/ 
        bool objectExists(const std::string &blockName) const;

        /*******************************************************************************/ 
        SDHierarchicalDatasetAccessor getDatasetAccessor() const;

        /*******************************************************************************/ 
        void mergeDatasetAccessor(const SDHierarchicalDatasetAccessor &dsaccessor);

        /*******************************************************************************/ 
        void lock();

        /*******************************************************************************/ 
        void waitLock();

        /*******************************************************************************/ 
        void unlock();

        /*******************************************************************************/ 
        std::string getConsistencyID();

        /*******************************************************************************/ 
        int getConsistencyCounter();

        /*******************************************************************************/ 
        void setTags(const std::vector<std::string> &tags) const;

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

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

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

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

        /*******************************************************************************/ 
        void setSeismicMeta(const std::string &seismicmeta);

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

        /*******************************************************************************/ 
        void setHttpContext(const HttpContext *context = nullptr);

      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 SDHierarchicalDatasetTest;
    };

}