DeviationSurveyRepresentation.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_0_1/WellboreTrajectoryRepresentation.h"

namespace RESQML2_NS
{
    class MdDatum;
}

namespace RESQML2_0_1_NS
{
    class WellboreTrajectoryRepresentation;

    class DLL_IMPORT_OR_EXPORT DeviationSurveyRepresentation : public RESQML2_NS::AbstractRepresentation
    {
    public:

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


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

        DeviationSurveyRepresentation(gsoap_resqml2_0_1::_resqml2__DeviationSurveyRepresentation* fromGsoap) : AbstractRepresentation(fromGsoap) {}

        ~DeviationSurveyRepresentation() {}

        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 firstStationLocation           XYZ location of the first station of the deviation survey in the local CRS. It must be three doubles. It is not created and not deleted by this method.
        * @param stationCount                   Number of stations (including the first station location).
        * @param mdUom                          Units of measure of the measured depths along this deviation survey.
        * @param mds                            MD values for the position of the stations. Array length equals station count.
        * @param angleUom                       Defines the units of measure for the azimuth and inclination
        * @param azimuths                       An array of azimuth angles, one for each survey station. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. Array length equals station count.
        * @param inclinations                   Dip (or inclination) angle for each station. Array length equals station count.
        * @param proxy                          The HDF proxy which indicates in which HDF5 file the numerical values will be stored.
        *                                       It must be already opened for writing and won't be closed.
        */
        void setGeometry(double * firstStationLocation, const ULONG64 & stationCount,
            const gsoap_resqml2_0_1::eml20__LengthUom & mdUom, double * mds,
            const gsoap_resqml2_0_1::eml20__PlaneAngleUom & angleUom, double * azimuths, double * inclinations,
            COMMON_NS::AbstractHdfProxy* proxy);

        void setMdDatum(RESQML2_NS::MdDatum* mdDatum);

        gsoap_resqml2_0_1::eml20__DataObjectReference* getMdDatumDor() const;

        RESQML2_NS::MdDatum * getMdDatum() const;

        std::string getMdDatumUuid() const;

        bool isFinal() const;

        ULONG64 getXyzPointCountOfPatch(const unsigned int & patchIndex) const;

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

        gsoap_resqml2_0_1::eml20__LengthUom getMdUom() const;

        gsoap_resqml2_0_1::eml20__PlaneAngleUom getAngleUom() const;

        void getMdValues(double* values);

        void getInclinations(double* values);

        void getAzimuths(double* values);

        std::vector<class WellboreFrameRepresentation*> getWellboreFrameRepresentationSet() const;

        unsigned int getWellboreFrameRepresentationCount() const;

        class WellboreFrameRepresentation* getWellboreFrameRepresentation(unsigned int index) const;

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

        unsigned int getWellboreTrajectoryRepresentationCount() const;

        class WellboreTrajectoryRepresentation* getWellboreTrajectoryRepresentation(const unsigned int & index) const;

        std::string getHdfProxyUuid() const;

        unsigned int getPatchCount() const {return 1;}

    protected:

        friend void WellboreTrajectoryRepresentation::setDeviationSurvey(DeviationSurveyRepresentation* deviationSurvey);

        void addTrajectory(class WellboreTrajectoryRepresentation* trajectory);

        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(COMMON_NS::EpcDocument* epcDoc);
        
        // XML backward relationships
        std::vector<class WellboreTrajectoryRepresentation*> wbTrajectoryRepSet;
    };
}