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 "resqml2/AbstractRepresentation.h"

namespace WITSML1_4_1_1_NS
{
    class Trajectory;
}

namespace RESQML2_0_1_NS
{
    class DLL_IMPORT_OR_EXPORT WellboreTrajectoryRepresentation : public RESQML2_NS::AbstractRepresentation
    {
    private:
        gsoap_resqml2_0_1::resqml2__PointGeometry* getPointGeometry2_0_1(const unsigned int & patchIndex) const {return nullptr;}

        gsoap_resqml2_0_1::_resqml2__WellboreTrajectoryRepresentation* getSpecializedGsoapProxy() const;

    public:

        WellboreTrajectoryRepresentation(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) :AbstractRepresentation(partialObject) {}


        WellboreTrajectoryRepresentation(class WellboreInterpretation* interp, const std::string & guid, const std::string & title, RESQML2_NS::MdDatum * mdInfo);

        WellboreTrajectoryRepresentation(class WellboreInterpretation* interp, const std::string & guid, const std::string & title, DeviationSurveyRepresentation* deviationSurvey);

        WellboreTrajectoryRepresentation(gsoap_resqml2_0_1::_resqml2__WellboreTrajectoryRepresentation* fromGsoap): AbstractRepresentation(fromGsoap),
                witsmlTrajectory(nullptr) {}

        ~WellboreTrajectoryRepresentation() {}

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

        /*
        *  Set the geometry of the representation by means of a parametric line without MD information.
        * @param controlPoints                  All the control points of all the cubic parametric lines. They are ordered by parametric line first.
        * @param controlPointCount              The count of control points and control point parameters per cubic parametric line.
        * @param lineKind                       Integer indicating the parametric line kind: 0 for vertical, 1 for linear spline, 2 for natural cubic spline, 3 for cubic spline, 4 for z linear cubic spline, 5 for minimum-curvature spline, (-1) for null: no line
        * @param proxy                          The HDF proxy which indicates in which HDF5 file the control points and its parameters will be stored.
        *                                       It must be already opened for writing and won't be closed.
        */
        void setGeometry(double * controlPoints, const double & startMd, const double & endMd, const unsigned int & controlPointCount, const int & lineKind, COMMON_NS::AbstractHdfProxy* proxy);

        /*
        *  Set the geometry of the representation by means of one natural cubic parametric line.
        * @param controlPoints                  All the control points of all the cubic parametric lines. They are ordered by parametric line first.
        * @param controlPointCount              The count of control points and control point parameters per cubic parametric line.
        * @param controlPointParameters         The arrays of control point parameters (ordered regarding the control points). It corresponds to the MD values in a WellboreFeature context.
        * @param proxy                          The HDF proxy which indicates in which HDF5 file the control points and its parameters will be stored.
        *                                       It must be already opened for writing and won't be closed.
        */
        void setGeometry(double * controlPoints, double* controlPointParameters, const unsigned int & controlPointCount,
            COMMON_NS::AbstractHdfProxy* proxy);

        /*
        *  Set the geometry of the representation by means of one cubic parametric line.
        * @param controlPoints                  All the control points of all the cubic parametric lines. They are ordered by parametric line first.
        * @param tangentVectors                 All the tangent vectors of all the control points of all the cubic parametric lines. They are ordered according to the control points.
        * @param controlPointCount              The count of control points and control point parameters and tangent vectors per cubic parametric line.
        * @param controlPointParameters         The arrays of control point parameters (ordered regarding the control points). It corresponds to the MD values in a WellboreFeature context.
        * @param proxy                          The HDF proxy which indicates in which HDF5 file the parameters and the tangent vectors will be stored.
        *                                       It must be already opened for writing and won't be closed.
        */
        void setGeometry(double * controlPoints,
            double * tangentVectors, double* controlPointParameters, const unsigned int & controlPointCount,
            COMMON_NS::AbstractHdfProxy* proxy);

        int getGeometryKind() const;

        void setMdDatum(RESQML2_NS::MdDatum* mdDatum);

        RESQML2_NS::MdDatum * getMdDatum() const;

        std::string getMdDatumUuid() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

        void getXyzPointsOfPatch(const unsigned int & patchIndex, double * xyzPoints) const;

        bool hasMdValues() const;

        gsoap_resqml2_0_1::eml20__LengthUom getMdUom() const;

        void getMdValues(double* values);

        double getStartMd() const;

        double getFinishMd() const;

        bool hasTangentVectors() const;

        void getTangentVectors(double* tangentVectors);

        void addParentTrajectory(const double & kickoffMd, const double & parentMd, WellboreTrajectoryRepresentation* parentTrajRep);

        WellboreTrajectoryRepresentation* getParentTrajectory() const;

        const double& getParentTrajectoryMd() const;

        const std::vector<WellboreTrajectoryRepresentation*> & getChildrenTrajectorySet() const;

        void addWellboreFrameRepresentation(class WellboreFrameRepresentation* WellboreFrameRepresentation) {wellboreFrameRepresentationSet.push_back(WellboreFrameRepresentation);}

        const std::vector<class WellboreFrameRepresentation*>& getWellboreFrameRepresentationSet() const {return wellboreFrameRepresentationSet;}

        unsigned int getWellboreFrameRepresentationCount() const {return static_cast<unsigned int>(wellboreFrameRepresentationSet.size());}

        class WellboreFrameRepresentation* getWellboreFrameRepresentation(const unsigned int & index) const {return wellboreFrameRepresentationSet[index];}

        void setDeviationSurvey(class DeviationSurveyRepresentation* deviationSurvey);

        class DeviationSurveyRepresentation* getDeviationSurvey() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* getLocalCrsDor() const;

        std::string getHdfProxyUuid() const;

        unsigned int getPatchCount() const {return 1;}

        bool hasGeometry() const;

        void setWitsmlTrajectory(WITSML1_4_1_1_NS::Trajectory * witsmlTraj);
        WITSML1_4_1_1_NS::Trajectory * getWitsmlTrajectory() {return witsmlTrajectory;}

    private:
        void addChildrenTrajectory(WellboreTrajectoryRepresentation* childrenTraj) { childrenTrajSet.push_back(childrenTraj); }

        gsoap_resqml2_0_1::eml20__DataObjectReference* getDeviationSurveyDor() const;

    protected:

        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);

        // XML forward relationships
        WITSML1_4_1_1_NS::Trajectory * witsmlTrajectory;
        
        // XML backward relationships
        std::vector<WellboreTrajectoryRepresentation*> childrenTrajSet;
        std::vector<class WellboreFrameRepresentation*> wellboreFrameRepresentationSet;
    };
}