WellboreGeometry.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"
 
#include "../MacroDefinitions.h"
 
namespace WITSML2_1_NS
{
    class WellboreGeometry : public WITSML2_NS::WellboreObject
    {
    public:

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

        WellboreGeometry(WITSML2_NS::Wellbore* witsmlWellbore,
            const std::string & guid,
            const std::string & title,
            bool isActive);

        WellboreGeometry(gsoap_eml2_3::witsml21__WellboreGeometry* fromGsoap) : WITSML2_NS::WellboreObject(fromGsoap) {}

        ~WellboreGeometry() = default;
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectReference getWellboreDor() const final;
        DLL_IMPORT_OR_EXPORT void setWellbore(WITSML2_NS::Wellbore* witsmlWellbore) final;
 
        //***************************************
        //************** SECTION ****************
        //***************************************
 
        // Mandatory
        GETTER_AND_SETTER_GENERIC_ATTRIBUTE_IN_VECTOR(std::string, WellboreGeometrySection, uid)
        GETTER_AND_SETTER_GENERIC_ATTRIBUTE_IN_VECTOR(time_t, WellboreGeometrySection, Creation)
        GETTER_AND_SETTER_GENERIC_ATTRIBUTE_IN_VECTOR(time_t, WellboreGeometrySection, LastUpdate)
 
        // Optional bool
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE_IN_VECTOR(bool, WellboreGeometrySection, CurveConductor)
 
        // Optional double
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE_IN_VECTOR(double, WellboreGeometrySection, FactFric)
 
        // Optional string
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE_IN_VECTOR(std::string, WellboreGeometrySection, Grade)
 
        // Optional enum
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE_IN_VECTOR(gsoap_eml2_3::witsml21__HoleCasingType, WellboreGeometrySection, TypeHoleCasing)
 
        // Optional Length Measure
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(WellboreGeometrySection, IdSection, gsoap_eml2_3::eml23__LengthUom)
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(WellboreGeometrySection, OdSection, gsoap_eml2_3::eml23__LengthUom)
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(WellboreGeometrySection, DiaDrift, gsoap_eml2_3::eml23__LengthUom)
 
        // Optional Mass per Length Measure
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE_IN_VECTOR(WellboreGeometrySection, WtPerLen, gsoap_eml2_3::eml23__MassPerLengthUom)

        DLL_IMPORT_OR_EXPORT double getWellboreGeometrySectionMdIntervalTop(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT double getWellboreGeometrySectionMdIntervalBase(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__LengthUom getWellboreGeometrySectionMdIntervalUom(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT void setWellboreGeometrySectionTvdInterval(uint64_t index, double top, double base, gsoap_eml2_3::eml23__LengthUom uom);

        DLL_IMPORT_OR_EXPORT double getWellboreGeometrySectionTvdIntervalTop(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::eml23__LengthUom getWellboreGeometrySectionTvdIntervalUom(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT double getWellboreGeometrySectionTvdIntervalBase(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT bool hasWellboreGeometrySectionTvdInterval(uint64_t index) const;

        DLL_IMPORT_OR_EXPORT void pushBackSection(double top, double base, gsoap_eml2_3::eml23__LengthUom uom, const std::string & uid = "");

        DLL_IMPORT_OR_EXPORT uint64_t getSectionCount() const;

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

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

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

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