Well.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 "../common/AbstractObject.h"
 
#include "../MacroDefinitions.h"
 
namespace RESQML2_NS
{
    class WellboreFeature;
}
 
namespace WITSML2_1_NS
{
    class WellCompletion;
}
 
namespace EML2_3_NS
{
    class LocalEngineering2dCrs;
    class VerticalCrs;
}
 
namespace WITSML2_NS
{
    class Wellbore;

    class Well : public COMMON_NS::AbstractObject
    {
    public:

        DLL_IMPORT_OR_EXPORT Well(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}

        virtual ~Well() = default;
 
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NameLegal)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumLicense)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumGovt)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Field)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Country)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, State)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, County)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Region)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, District)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Block)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, OperatorDiv)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumAPI)
 
        // Optional enum
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::eml23__WellStatus, StatusWell)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::witsml21__WellPurpose, PurposeWell)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::witsml21__WellFluid, FluidWell)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_3::witsml21__WellDirection, DirectionWell)
 
        ABSTRACT_GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE(WaterDepth, gsoap_eml2_3::eml23__LengthUom)
        ABSTRACT_GETTER_PRESENCE_ATTRIBUTE(GroundElevation)
        ABSTRACT_GETTER_PRESENCE_ATTRIBUTE(WellheadElevation)
 
        ABSTRACT_GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE(PcInterest, gsoap_eml2_3::eml23__DimensionlessUom)
 
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimLicense)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimSpud)
        ABSTRACT_GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimPa)
 
        
        DLL_IMPORT_OR_EXPORT virtual void setGroundElevation(double value, gsoap_eml2_3::eml23__LengthUom uom, EML2_3_NS::VerticalCrs* verticalCrs) = 0;

        DLL_IMPORT_OR_EXPORT virtual double getGroundElevationValue() const = 0;

        DLL_IMPORT_OR_EXPORT virtual gsoap_eml2_3::eml23__LengthUom getGroundElevationUom() const = 0;

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getGroundElevationDatumDor() const = 0;

        DLL_IMPORT_OR_EXPORT EML2_3_NS::VerticalCrs* getGroundElevationDatum() const;

        DLL_IMPORT_OR_EXPORT virtual void setWellheadElevation(double value, gsoap_eml2_3::eml23__LengthUom uom, EML2_3_NS::VerticalCrs* verticalCrs) = 0;

        DLL_IMPORT_OR_EXPORT virtual double getWellheadElevationValue() const = 0;

        DLL_IMPORT_OR_EXPORT virtual gsoap_eml2_3::eml23__LengthUom getWellheadElevationUom() const = 0;

        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getWellheadElevationDatumDor() const = 0;

        DLL_IMPORT_OR_EXPORT EML2_3_NS::VerticalCrs* getWellheadElevationDatum() const;

        DLL_IMPORT_OR_EXPORT virtual void setTimeZone(bool direction, unsigned short hours, unsigned short minutes) = 0;
        ABSTRACT_GETTER_PRESENCE_ATTRIBUTE(TimeZone)

        DLL_IMPORT_OR_EXPORT virtual bool getTimeZoneDirection() const = 0;

        DLL_IMPORT_OR_EXPORT virtual unsigned short getTimeZoneHours() const = 0;

        DLL_IMPORT_OR_EXPORT virtual unsigned short getTimeZoneMinutes() const = 0;

        DLL_IMPORT_OR_EXPORT virtual double getLocationProjectedX(uint64_t locationIndex) = 0;

        DLL_IMPORT_OR_EXPORT virtual double getLocationProjectedY(uint64_t locationIndex) = 0;

        DLL_IMPORT_OR_EXPORT virtual void pushBackLocation(double projectedX, double projectedY, EML2_3_NS::LocalEngineering2dCrs* crs) = 0;

        DLL_IMPORT_OR_EXPORT virtual uint64_t geLocationCount() const = 0;
 
        GETTER_DATAOBJECTS(RESQML2_NS::WellboreFeature, ResqmlWellboreFeature)
        GETTER_DATAOBJECTS(WITSML2_NS::Wellbore, Wellbore)
        GETTER_DATAOBJECTS(WITSML2_1_NS::WellCompletion, Wellcompletion)

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

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

        Well() = default;

        Well(gsoap_eml2_3::witsml21__Well* fromGsoap) : COMMON_NS::AbstractObject(fromGsoap) {}

        void loadTargetRelationships();
    };
}