WellboreTrajectoryRepresentation.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 "AbstractRepresentation.h"
 
namespace RESQML2_NS
{
    class WellboreInterpretation;
 
    class WellboreTrajectoryRepresentation : public AbstractRepresentation
    {
    public:
 
        virtual ~WellboreTrajectoryRepresentation() = default;
 
        DLL_IMPORT_OR_EXPORT virtual void setMinimalGeometry(double startMd, double endMd) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometry(double const* controlPoints, double startMd, double endMd, uint64_t controlPointCount, int lineKind, EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs* localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometry(double const* controlPoints, double const* controlPointParameters, uint64_t controlPointCount, int lineKind,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs* localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setGeometry(double const* controlPoints,
            double const* tangentVectors, double const* controlPointParameters, uint64_t controlPointCount, int lineKind,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs* localCrs = nullptr) = 0;
 
        DLL_IMPORT_OR_EXPORT void setGeometry(double const* controlPoints,
            double const* inclinations, double const* azimuths, double const* controlPointParameters, uint64_t controlPointCount, int lineKind,
            EML2_NS::AbstractHdfProxy* proxy = nullptr, EML2_NS::AbstractLocal3dCrs* localCrs = nullptr);
 
        DLL_IMPORT_OR_EXPORT virtual int getGeometryKind() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void setMdDatum(MdDatum * mdDatum) = 0;
 
        DLL_IMPORT_OR_EXPORT RESQML2_NS::MdDatum * getMdDatum() const;
 
        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getMdDatumDor() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual bool hasMdValues() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual gsoap_resqml2_0_1::eml20__LengthUom getMdUom() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void getMdValues(double* values) const = 0;
 
        DLL_IMPORT_OR_EXPORT void convertMdValuesToXyzValues(double* mdValues, uint64_t mdCount, double* xyzPoints) const;
 
        DLL_IMPORT_OR_EXPORT virtual double getStartMd() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual double getFinishMd() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual bool hasTangentVectors() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual void getTangentVectors(double* tangentVectors) = 0;
 
        DLL_IMPORT_OR_EXPORT void getInclinationsAndAzimuths(double * inclinations, double * azimuths);
 
        //*****************
        //*** PARENTAGE ***
        //*****************
 
        DLL_IMPORT_OR_EXPORT void virtual addParentTrajectory(double kickoffMd, double parentMd, WellboreTrajectoryRepresentation* parentTrajRep) = 0;
 
        DLL_IMPORT_OR_EXPORT WellboreTrajectoryRepresentation* getParentTrajectory() const;
 
        DLL_IMPORT_OR_EXPORT virtual COMMON_NS::DataObjectReference getParentTrajectoryDor() const = 0;
 
        DLL_IMPORT_OR_EXPORT virtual double getParentTrajectoryMd() const = 0;
 
        DLL_IMPORT_OR_EXPORT std::vector<WellboreTrajectoryRepresentation*> getChildrenTrajectorySet() const;
 
        //*****************
        //***** FRAME *****
        //*****************
 
        DLL_IMPORT_OR_EXPORT std::vector<class RESQML2_NS::WellboreFrameRepresentation *> getWellboreFrameRepresentationSet() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getWellboreFrameRepresentationCount() const; // Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet.
 
        DLL_IMPORT_OR_EXPORT class RESQML2_NS::WellboreFrameRepresentation * getWellboreFrameRepresentation(unsigned int index) const; // Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet.
 
        virtual COMMON_NS::DataObjectReference getLocalCrsDor(uint64_t patchIndex) const override = 0;
 
        virtual COMMON_NS::DataObjectReference getHdfProxyDor() const override = 0;
 
        DLL_IMPORT_OR_EXPORT uint64_t getPatchCount() const final {return 1;}
 
        DLL_IMPORT_OR_EXPORT virtual bool hasGeometry() const = 0;
 
        DLL_IMPORT_OR_EXPORT static constexpr char const* XML_TAG = "WellboreTrajectoryRepresentation";
 
        DLL_IMPORT_OR_EXPORT virtual std::string getXmlTag() const final { return XML_TAG; }
 
    protected:
 
        DLL_IMPORT_OR_EXPORT WellboreTrajectoryRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : AbstractRepresentation(partialObject) {}
 
        WellboreTrajectoryRepresentation() {}
 
        WellboreTrajectoryRepresentation(gsoap_resqml2_0_1::_resqml20__WellboreTrajectoryRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}
        WellboreTrajectoryRepresentation(gsoap_eml2_3::_resqml22__WellboreTrajectoryRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}
 
        void loadTargetRelationships() override;
    };
}