WellboreCompletion.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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 "../witsml2/WellboreObject.h"
 
namespace WITSML2_1_NS
{
    class WellboreCompletion : public WITSML2_NS::WellboreObject
    {
    public:

        enum class WellReservoirConnectionType { PERFORATION = 0, GRAVEL_PACK = 1, OPEN_HOLE = 2, SLOTS = 3};

        DLL_IMPORT_OR_EXPORT WellboreCompletion(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : WITSML2_NS::WellboreObject(partialObject) {}

        WellboreCompletion(WITSML2_NS::Wellbore* witsmlWellbore,
            const std::string & guid,
            const std::string & title);

        WellboreCompletion(gsoap_eml2_3::witsml21__WellboreCompletion* fromGsoap) :WellboreObject(fromGsoap) {}

        ~WellboreCompletion() = default;

        COMMON_NS::DataObjectReference getWellboreDor() const final;

        COMMON_NS::DataObjectReference getWellCompletionDor() const;

        DLL_IMPORT_OR_EXPORT class WellCompletion* getWellCompletion() const;

        DLL_IMPORT_OR_EXPORT void setWellbore(WITSML2_NS::Wellbore* witsmlWellbore) final;

        DLL_IMPORT_OR_EXPORT void setWellCompletion(class WellCompletion* wellCompletion);

        DLL_IMPORT_OR_EXPORT void pushBackConnection(WellReservoirConnectionType wellReservoirConnection,
            gsoap_eml2_3::eml23__LengthUom MdUnit,
            double TopMd,
            double BaseMd, 
            const std::string & uid);

        DLL_IMPORT_OR_EXPORT void pushBackConnectionExtraMetadata(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex,
            const std::string & key, const std::string & value);

        DLL_IMPORT_OR_EXPORT void pushBackConnectionHistory(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex,
            const std::string & historyGuid = "");

        DLL_IMPORT_OR_EXPORT void pushBackConnectionHistory(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex,
            gsoap_eml2_3::witsml21__PhysicalStatus staus,
            time_t startDate,
            const std::string & historyGuid = "");

        DLL_IMPORT_OR_EXPORT uint64_t getConnectionCount(WellReservoirConnectionType wellReservoirConnection) const;

        DLL_IMPORT_OR_EXPORT std::string getConnectionUid(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT std::vector<std::string> getConnectionExtraMetadata(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string & key) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionMdDatum(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionMdInterval(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__LengthUom getConnectionMdUnit(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getConnectionMdUnitAsString(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT double getConnectionTopMd(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT double getConnectionBaseMd(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT uint64_t getConnectionHistoryCount(WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryStatus(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::witsml21__PhysicalStatus getConnectionHistoryStatus(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getConnectionHistoryStatusToString(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT void setConnectionHistoryStatus(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, 
            gsoap_eml2_3::witsml21__PhysicalStatus connectionStatus);

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryStartDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT time_t getConnectionHistoryStartDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT void setConnectionHistoryStartDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t startDate) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryEndDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT time_t getConnectionHistoryEndDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT void setConnectionHistoryEndDate(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t endDate) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryMdDatum(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryMdInterval(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__LengthUom getConnectionHistoryMdUnit(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getConnectionHistoryMdUnitAsString(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT double getConnectionHistoryTopMd(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT void setConnectionHistoryMdInterval(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex,
            gsoap_eml2_3::eml23__LengthUom MdUnit,
            double TopMd, double baseMd);

        DLL_IMPORT_OR_EXPORT double getConnectionHistoryBaseMd(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT bool hasConnectionHistoryComment(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT std::string getConnectionHistoryComment(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const;

        DLL_IMPORT_OR_EXPORT void setConnectionHistoryComment(uint64_t historyIndex,
            WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex,
            const std::string & comment);

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "WellboreCompletion";

        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const { return XML_TAG; }

        void loadTargetRelationships() final;

        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_NS = "witsml21";

        DLL_IMPORT_OR_EXPORT std::string getXmlNamespace() const final { return XML_NS; }
 
    private:

        gsoap_eml2_3::witsml21__PerforationSetInterval* getPerforation(uint64_t index) const;

        gsoap_eml2_3::witsml21__GravelPackInterval* getGravelPack(uint64_t index) const;

        gsoap_eml2_3::witsml21__OpenHoleInterval* getOpenHole(uint64_t index) const;

        gsoap_eml2_3::witsml21__SlotsInterval* getSlots(uint64_t index) const;

        gsoap_eml2_3::witsml21__PerforationStatusHistory* getPerforationHistoryEntry(uint64_t historyIndex,
            uint64_t index) const {
            return getPerforation(index)->PerforationStatusHistory.at(historyIndex);
        }

        gsoap_eml2_3::witsml21__IntervalStatusHistory* getGravelPackHistoryEntry(uint64_t historyIndex,
            uint64_t index) const {
            return getGravelPack(index)->StatusHistory.at(historyIndex);
        }

        gsoap_eml2_3::witsml21__IntervalStatusHistory* getOpenHoleHistoryEntry(uint64_t historyIndex,
            uint64_t index) const {
            return getOpenHole(index)->StatusHistory.at(historyIndex);
        }

        gsoap_eml2_3::witsml21__IntervalStatusHistory* getSlotsHistoryEntry(uint64_t historyIndex,
            uint64_t index) const {
            return getSlots(index)->StatusHistory.at(historyIndex);
        }
    };
}