Params.h

Go to the documentation of this file.

// ============================================================================
// Copyright 2024, 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 <memory>
#include <string>

namespace seismicdrive
{
    struct DLL_PUBLIC Params
    {
        Params();
        explicit Params(const std::string &correlationId);
        Params &withCorrelationId(const std::string &value);
        const std::string &getCorrelationId() const;
#ifdef _MSC_VER
    #pragma warning(push)
    #pragma warning(disable : 4251)
#endif
        struct Impl;
        std::shared_ptr<Impl> _impl;
#ifdef _MSC_VER
    #pragma warning(pop)
#endif
    };

    namespace dataset
    {
        struct DLL_PUBLIC ParamsOpen : public Params
        {
            ParamsOpen();
            explicit ParamsOpen(const Params &params);
            explicit ParamsOpen(const SDDatasetDisposition disposition);
            ParamsOpen &withDisposition(const SDDatasetDisposition value);
            ParamsOpen &withLegalTag(const std::string &value);
            ParamsOpen &withWriteId(const std::string &value);
            ParamsOpen &withSeismicMeta(const std::string &value);
            ParamsOpen &withPedantic(const bool value);
            ParamsOpen &withFlushManifest(const bool value);
            ParamsOpen &withReadonlyOnClose(const bool value);
            SDDatasetDisposition getDisposition() const;
            const std::string &getLegalTag() const;
            const std::string &getWriteId() const;
            const std::string &getSeismicMeta() const;
            bool getPedantic() const;
            bool getFlushManifest() const;
            bool getReadonlyOnClose() const;
#ifdef _MSC_VER
    #pragma warning(push)
    #pragma warning(disable : 4251)
#endif
            struct Impl;
            std::shared_ptr<Impl> _impl;
#ifdef _MSC_VER
    #pragma warning(pop)
#endif
        };
    } // namespace dataset
} // namespace seismicdrive