AbstractObject.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/EpcDocument.h"

namespace WITSML1_4_1_1_NS
{
    class DLL_IMPORT_OR_EXPORT AbstractObject
    {
    protected:      
        gsoap_witsml1_4_1_1::abstract__abstractObject* collection;
        COMMON_NS::EpcDocument* epcDocument;

        // forward relationshsip
        class CoordinateReferenceSystem* crs;

        bool updateXml; 
        
        AbstractObject(gsoap_witsml1_4_1_1::abstract__abstractObject* proxy = nullptr) : collection(proxy), epcDocument (nullptr), crs(nullptr), updateXml(true) {}

        friend void COMMON_NS::EpcDocument::addGsoapProxy(WITSML1_4_1_1_NS::AbstractObject* proxy);

        gsoap_witsml1_4_1_1::witsml1__cs_USCOREcommonData* newCommonData(
            const std::string & sourceName,
            const time_t & dTimCreation,
            const time_t & dTimLastChange,
            const std::string & comments);

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

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

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

    public:
        virtual ~AbstractObject() {}

        static const char* SCHEMA_VERSION;

        virtual const std::string & getTitle() const = 0;

        virtual std::string getUuid() const = 0;
        virtual time_t getCreation() const = 0;
        virtual time_t getLastUpdate() const = 0;

        gsoap_witsml1_4_1_1::abstract__abstractObject* getGsoapProxy() {return collection;}

        void serializeIntoStream(std::ostream * stream);

        int getGsoapType() const {return collection->soap_type();}

        COMMON_NS::EpcDocument* getEpcDocument() const {return epcDocument;}

        virtual std::string getXmlNamespace() const {return "witsml1";}

        virtual std::string getXmlTag() const = 0;

        std::string getContentType() const;
        
        std::string getPartNameInEpcDocument() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* newResqmlReference() const;

        void setCoordinateReferenceSystem(class CoordinateReferenceSystem* wellCrs);

        class CoordinateReferenceSystem* getCoordinateReferenceSystem() const {return crs;}

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

        virtual void importRelationshipSetFromEpc(COMMON_NS::EpcDocument * epcDoc) = 0;

        std::string serializeIntoString();
    };
}