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 "witsml1_4_1_1/Wellbore.h"

#include "tools/TimeTools.h"

namespace WITSML1_4_1_1_NS
{
    class DLL_IMPORT_OR_EXPORT Well : public AbstractObject
    {
    public:
        Well(soap* soapContext,
            const std::string & guid,
            const std::string & title,
            const std::string & timeZone);

        Well(soap* soapContext,
            const std::string & guid,
            const std::string & title,
            const std::string & timeZone,
            const std::string & operator_,
            gsoap_witsml1_4_1_1::witsml1__WellStatus statusWell,
            gsoap_witsml1_4_1_1::witsml1__WellPurpose purposeWell,
            gsoap_witsml1_4_1_1::witsml1__WellFluid fluidWell,
            gsoap_witsml1_4_1_1::witsml1__WellDirection directionWell,
            const time_t & dTimSpud,
            const std::string & sourceName,
            const time_t & dTimCreation,
            const time_t & dTimLastChange,
            const std::string & comments
        );

        Well(gsoap_witsml1_4_1_1::_witsml1__wells* fromGsoap):AbstractObject(fromGsoap)  {}

        ~Well() {}

        Wellbore* createWellbore(
            const std::string & guid,
            const std::string & title);

        Wellbore* createWellbore(
            const std::string & guid,
            const std::string & title,
            gsoap_witsml1_4_1_1::witsml1__WellStatus statusWellbore,
            const bool & isActive,
            gsoap_witsml1_4_1_1::witsml1__WellPurpose purposeWellbore,
            gsoap_witsml1_4_1_1::witsml1__WellboreType typeWellbore,
            const bool & achievedTD,
            const std::string & sourceName,
            const time_t & dTimCreation,
            const time_t & dTimLastChange,
            const std::string & comments
        );

        void setOperator(const std::string & operator_);

        double getWellHeadEastingLocationValue();
        gsoap_witsml1_4_1_1::witsml1__LengthUom getWellHeadEastingLocationUom();
        double getWellHeadNorthingLocationValue();
        gsoap_witsml1_4_1_1::witsml1__LengthUom getWellHeadNorthingLocationUom();

        void setEastingNorthingLocation(
            gsoap_witsml1_4_1_1::witsml1__LengthUom uom,
            const double & easting,
            const double & northing,
            class CoordinateReferenceSystem* wellCrs);

        void setWestingSouthingLocation(
            gsoap_witsml1_4_1_1::witsml1__LengthUom uom,
            const double & westing,
            const double & southing,
            class CoordinateReferenceSystem* wellCrs);

        void setProjectedXProjectedYLocation(
            gsoap_witsml1_4_1_1::witsml1__LengthUom uom,
            const double & projectedX,
            const double & projectedY,
            class CoordinateReferenceSystem* wellCrs);

        soap* getGSoapContext() const {return collection->soap;}

        const std::vector<Wellbore*>& getWellbores() const {return wellboreSet;}

        const std::string & getTitle() const {return static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->name;}

        std::string getUuid() const {return *static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->uid;}
        time_t getCreation() const
        {
            if (static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->commonData->dTimCreation)
                return timeTools::timegm(static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->commonData->dTimCreation);
            else
                return -1;
        }
        time_t getLastUpdate() const
        {
            if (static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->commonData->dTimLastChange)
                return timeTools::timegm(static_cast<gsoap_witsml1_4_1_1::_witsml1__wells*>(collection)->well[0]->commonData->dTimLastChange);
            else
                return -1;
        }
        
        // KB
        void pushBackDatum(
            const std::string & guid, 
            const std::string & title,
            gsoap_witsml1_4_1_1::witsml1__ElevCodeEnum code,
            const unsigned int & datumIndex,
            gsoap_witsml1_4_1_1::witsml1__WellVerticalCoordinateUom elevationUnit,
            const double & elevation);

        // SL
        void pushBackDatum(
            const std::string & guid, 
            const std::string & title,
            gsoap_witsml1_4_1_1::witsml1__ElevCodeEnum code,
            const std::string & refNamingSystem,
            const std::string & refCode,
            const std::string & refName);

        unsigned int getDatumCount() const;

        gsoap_witsml1_4_1_1::witsml1__cs_USCOREwellDatum* getDatum(const unsigned int & index) const;
        gsoap_witsml1_4_1_1::witsml1__cs_USCOREwellDatum* getDatum(const std::string & uid) const;
        
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);

        std::vector<epc::Relationship> getAllEpcRelationships() const;

        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

    protected:

        // backwards relationship
        std::vector<Wellbore*> wellboreSet;

        friend void Wellbore::setWell(Well* witsmlWell);
    };
}