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 "AbstractObject.h"
 
namespace WITSML2_0_NS
{
    class Wellbore;
    class WellCompletion;
 
    class Well : public WITSML2_0_NS::AbstractObject
    {
    public:
 
        DLL_IMPORT_OR_EXPORT Well(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : WITSML2_0_NS::AbstractObject(partialObject) {}
 
        Well(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid,
            const std::string & title);
 
        Well(COMMON_NS::DataObjectRepository * repo,
            const std::string & guid,
            const std::string & title,
            const std::string & operator_,
            gsoap_eml2_1::eml21__WellStatus statusWell,
            gsoap_eml2_1::witsml20__WellDirection directionWell
        );
 
        Well(gsoap_eml2_1::witsml20__Well* fromGsoap):AbstractObject(fromGsoap)  {}
 
        ~Well() = default;
 
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NameLegal)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumLicense)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumGovt)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Field)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Country)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, State)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, County)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Region)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, District)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Block)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, Operator)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, OperatorDiv)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, OriginalOperator)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(std::string, NumAPI)
 
        // Optional enum
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_1::eml21__WellStatus, StatusWell)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_1::witsml20__WellPurpose, PurposeWell)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_1::witsml20__WellFluid, FluidWell)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(gsoap_eml2_1::witsml20__WellDirection, DirectionWell)
 
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE(WaterDepth, gsoap_eml2_1::eml21__LengthUom)
        GETTER_PRESENCE_ATTRIBUTE(GroundElevation)
 
        GETTER_AND_SETTER_MEASURE_OPTIONAL_ATTRIBUTE(PcInterest, gsoap_eml2_1::eml21__DimensionlessUom)
 
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimLicense)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimSpud)
        GETTER_AND_SETTER_GENERIC_OPTIONAL_ATTRIBUTE(time_t, DTimPa)
 
        
        DLL_IMPORT_OR_EXPORT void setGroundElevation(double value, gsoap_eml2_1::eml21__LengthUom uom, const std::string& datum);
 
        DLL_IMPORT_OR_EXPORT double getGroundElevationValue() const;
 
        DLL_IMPORT_OR_EXPORT gsoap_eml2_1::eml21__LengthUom getGroundElevationUom() const;
 
        DLL_IMPORT_OR_EXPORT std::string getGroundElevationDatum() const;
 
        DLL_IMPORT_OR_EXPORT void setTimeZone(bool direction, unsigned short hours, unsigned short minutes = 0);
        GETTER_PRESENCE_ATTRIBUTE(TimeZone)
 
        DLL_IMPORT_OR_EXPORT bool getTimeZoneDirection() const;
 
        DLL_IMPORT_OR_EXPORT unsigned short getTimeZoneHours() const;
 
        DLL_IMPORT_OR_EXPORT unsigned short getTimeZoneMinutes() const;
 
        DLL_IMPORT_OR_EXPORT double getLocationProjectedX(unsigned int locationIndex);
 
        DLL_IMPORT_OR_EXPORT double getLocationProjectedY(unsigned int locationIndex);
 
        DLL_IMPORT_OR_EXPORT void pushBackLocation(
            const std::string & guid,
            double projectedX,
            double projectedY,
            unsigned int projectedCrsEpsgCode);
 
        DLL_IMPORT_OR_EXPORT unsigned int geLocationCount() const;
 
        DLL_IMPORT_OR_EXPORT void pushBackDatum(
            const std::string & guid, 
            const std::string & title,
            gsoap_eml2_1::eml21__WellboreDatumReference code,
            const std::string & datum,
            gsoap_eml2_1::eml21__LengthUom elevationUnit,
            double elevation,
            unsigned int verticalCrsEpsgCode);
 
        DLL_IMPORT_OR_EXPORT unsigned int getDatumCount() const;
 
        DLL_IMPORT_OR_EXPORT std::vector<RESQML2_NS::WellboreFeature *> getResqmlWellboreFeatures() const;
 
        DLL_IMPORT_OR_EXPORT std::vector<Wellbore *> getWellbores() const;
 
        DLL_IMPORT_OR_EXPORT std::vector<WellCompletion *> getWellcompletions() const;
 
        DLL_IMPORT_OR_EXPORT static const char* XML_TAG;
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const { return XML_TAG; }
 
    protected:
 
        void loadTargetRelationships();
    };
}